DodoDentist Webhook subscriptions API
The Webhook subscriptions API from DodoDentist — 2 operation(s) for webhook subscriptions.
The Webhook subscriptions API from DodoDentist — 2 operation(s) for webhook subscriptions.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/dododentist-com:dododentist-com-webhook-subscriptions-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: DodoDentist Webhook subscriptions API
version: 1.0.0
description: 'Public REST API for DodoDentist. Authenticate with an API key created in the DodoDentist dashboard: send the base64-encoded key secret with HTTP Basic auth. Each key carries per-resource scopes like `patients:read` or `appointments:write`.'
servers:
- url: https://api.dododentist.com
tags:
- name: Webhook Subscriptions
paths:
/api/webhooksubscriptions:
get:
tags:
- Webhook Subscriptions
summary: List webhook subscriptions
description: 'Webhook subscriptions deliver `patient.created`, `patient.updated`, `patient.deleted`, `appointment.created`, `appointment.updated`, `appointment.deleted`, `invoice.*` and `payment.*` events to your server as signed POST requests (`X-Dododentist-Signature: t=,v1=`). An endpoint failing 20 times in a row is disabled automatically. Subscriptions are managed with an operator access token; the `secret` is only returned once, on create.'
security:
- accessToken: []
responses:
'200':
description: Array of webhook subscriptions (without secrets)
content:
application/json:
schema:
type: array
items:
type: object
properties:
_id:
type: string
minLength: 1
clinicId:
type: string
minLength: 1
url:
type: string
format: uri
events:
type: array
items:
type: string
active:
type: boolean
creationTime:
type: string
format: date-time
default:
description: Error response
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
name:
type: string
statusCode:
type: integer
details:
type: object
additionalProperties: true
operationId: getApiWebhooksubscriptions
x-codeSamples:
- lang: Node + Request
source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://api.dododentist.com/api/webhooksubscriptions',\n headers: {Authorization: 'REPLACE_KEY_VALUE'}\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
- lang: Shell + Curl
source: "curl --request GET \\\n --url https://api.dododentist.com/api/webhooksubscriptions \\\n --header 'Authorization: REPLACE_KEY_VALUE'"
- lang: Shell + Httpie
source: "http GET https://api.dododentist.com/api/webhooksubscriptions \\\n Authorization:REPLACE_KEY_VALUE"
- lang: Python + Python3
source: 'import http.client
conn = http.client.HTTPSConnection("api.dododentist.com")
headers = { ''Authorization'': "REPLACE_KEY_VALUE" }
conn.request("GET", "/api/webhooksubscriptions", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))'
- lang: Php + Curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.dododentist.com/api/webhooksubscriptions\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: Php + Http1
source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.dododentist.com/api/webhooksubscriptions');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"
- lang: Php + Http2
source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$request->setRequestUrl('https://api.dododentist.com/api/webhooksubscriptions');\n$request->setRequestMethod('GET');\n$request->setHeaders([\n 'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
post:
tags:
- Webhook Subscriptions
summary: Create a webhook subscription
description: The response includes the signing `secret` exactly once — store it; it cannot be retrieved again.
security:
- accessToken: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- clinicId
- url
properties:
clinicId:
type: string
url:
type: string
example: https://example.com/dododentist-webhook
events:
type: array
description: Empty array subscribes to all events
items:
type: string
enum:
- patient.created
- patient.updated
- patient.deleted
- appointment.created
- appointment.updated
- appointment.deleted
- invoice.created
- invoice.updated
- invoice.deleted
- payment.created
- payment.updated
- payment.deleted
responses:
'200':
description: The created subscription, including its secret
content:
application/json:
schema:
type: object
properties:
_id:
type: string
minLength: 1
clinicId:
type: string
minLength: 1
url:
type: string
format: uri
events:
type: array
items:
type: string
active:
type: boolean
creationTime:
type: string
format: date-time
default:
description: Error response
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
name:
type: string
statusCode:
type: integer
details:
type: object
additionalProperties: true
operationId: postApiWebhooksubscriptions
x-codeSamples:
- lang: Node + Request
source: "const request = require('request');\n\nconst options = {\n method: 'POST',\n url: 'https://api.dododentist.com/api/webhooksubscriptions',\n headers: {'content-type': 'application/json', Authorization: 'REPLACE_KEY_VALUE'},\n body: {\n clinicId: 'string',\n url: 'https://example.com/dododentist-webhook',\n events: ['patient.created']\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
- lang: Shell + Curl
source: "curl --request POST \\\n --url https://api.dododentist.com/api/webhooksubscriptions \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"clinicId\":\"string\",\"url\":\"https://example.com/dododentist-webhook\",\"events\":[\"patient.created\"]}'"
- lang: Shell + Httpie
source: "echo '{\"clinicId\":\"string\",\"url\":\"https://example.com/dododentist-webhook\",\"events\":[\"patient.created\"]}' | \\\n http POST https://api.dododentist.com/api/webhooksubscriptions \\\n Authorization:REPLACE_KEY_VALUE \\\n content-type:application/json"
- lang: Python + Python3
source: "import http.client\n\nconn = http.client.HTTPSConnection(\"api.dododentist.com\")\n\npayload = \"{\\\"clinicId\\\":\\\"string\\\",\\\"url\\\":\\\"https://example.com/dododentist-webhook\\\",\\\"events\\\":[\\\"patient.created\\\"]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/webhooksubscriptions\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
- lang: Php + Curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.dododentist.com/api/webhooksubscriptions\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"clinicId\\\":\\\"string\\\",\\\"url\\\":\\\"https://example.com/dododentist-webhook\\\",\\\"events\\\":[\\\"patient.created\\\"]}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: Php + Http1
source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.dododentist.com/api/webhooksubscriptions');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'content-type' => 'application/json',\n 'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$request->setBody('{\"clinicId\":\"string\",\"url\":\"https://example.com/dododentist-webhook\",\"events\":[\"patient.created\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"
- lang: Php + Http2
source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$body = new http\\Message\\Body;\n$body->append('{\"clinicId\":\"string\",\"url\":\"https://example.com/dododentist-webhook\",\"events\":[\"patient.created\"]}');\n\n$request->setRequestUrl('https://api.dododentist.com/api/webhooksubscriptions');\n$request->setRequestMethod('POST');\n$request->setBody($body);\n\n$request->setHeaders([\n 'content-type' => 'application/json',\n 'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
/api/webhooksubscriptions/{webhookSubscriptionId}:
put:
tags:
- Webhook Subscriptions
summary: Update a webhook subscription
description: '`url`, `events` and `active` are editable; the secret and clinic are immutable. Re-enabling an auto-disabled endpoint is done by setting `active` back to true.'
security:
- accessToken: []
parameters:
- in: path
name: webhookSubscriptionId
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: The updated subscription (without secret)
content:
application/json:
schema:
type: object
properties:
_id:
type: string
minLength: 1
clinicId:
type: string
minLength: 1
url:
type: string
format: uri
events:
type: array
items:
type: string
active:
type: boolean
creationTime:
type: string
format: date-time
default:
description: Error response
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
name:
type: string
statusCode:
type: integer
details:
type: object
additionalProperties: true
operationId: putApiWebhooksubscriptionsWebhookSubscriptionId
x-codeSamples:
- lang: Node + Request
source: "const request = require('request');\n\nconst options = {\n method: 'PUT',\n url: 'https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D',\n headers: {'content-type': 'application/json', Authorization: 'REPLACE_KEY_VALUE'},\n body: {},\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
- lang: Shell + Curl
source: "curl --request PUT \\\n --url https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{}'"
- lang: Shell + Httpie
source: "echo '{}' | \\\n http PUT https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D \\\n Authorization:REPLACE_KEY_VALUE \\\n content-type:application/json"
- lang: Python + Python3
source: "import http.client\n\nconn = http.client.HTTPSConnection(\"api.dododentist.com\")\n\npayload = \"{}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"PUT\", \"/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
- lang: Php + Curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"PUT\",\n CURLOPT_POSTFIELDS => \"{}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: Php + Http1
source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D');\n$request->setMethod(HTTP_METH_PUT);\n\n$request->setHeaders([\n 'content-type' => 'application/json',\n 'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$request->setBody('{}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"
- lang: Php + Http2
source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$body = new http\\Message\\Body;\n$body->append('{}');\n\n$request->setRequestUrl('https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D');\n$request->setRequestMethod('PUT');\n$request->setBody($body);\n\n$request->setHeaders([\n 'content-type' => 'application/json',\n 'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
delete:
tags:
- Webhook Subscriptions
summary: Delete a webhook subscription
security:
- accessToken: []
parameters:
- in: path
name: webhookSubscriptionId
required: true
schema:
type: string
responses:
'200':
description: Deleted
content:
application/json:
schema:
type: object
properties:
_id:
type: string
minLength: 1
clinicId:
type: string
minLength: 1
url:
type: string
format: uri
events:
type: array
items:
type: string
active:
type: boolean
creationTime:
type: string
format: date-time
default:
description: Error response
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
name:
type: string
statusCode:
type: integer
details:
type: object
additionalProperties: true
operationId: deleteApiWebhooksubscriptionsWebhookSubscriptionId
x-codeSamples:
- lang: Node + Request
source: "const request = require('request');\n\nconst options = {\n method: 'DELETE',\n url: 'https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D',\n headers: {Authorization: 'REPLACE_KEY_VALUE'}\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
- lang: Shell + Curl
source: "curl --request DELETE \\\n --url https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"
- lang: Shell + Httpie
source: "http DELETE https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D \\\n Authorization:REPLACE_KEY_VALUE"
- lang: Python + Python3
source: 'import http.client
conn = http.client.HTTPSConnection("api.dododentist.com")
headers = { ''Authorization'': "REPLACE_KEY_VALUE" }
conn.request("DELETE", "/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))'
- lang: Php + Curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"DELETE\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: Php + Http1
source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"
- lang: Php + Http2
source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$request->setRequestUrl('https://api.dododentist.com/api/webhooksubscriptions/%7BwebhookSubscriptionId%7D');\n$request->setRequestMethod('DELETE');\n$request->setHeaders([\n 'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
components:
securitySchemes:
apiKey:
type: http
scheme: basic
description: 'HTTP Basic auth carrying only the API key secret: `Authorization: Basic base64(<key secret>)`.'
accessToken:
type: apiKey
in: header
name: Authorization
description: 'Operator session token issued by the DodoDentist dashboard: `Authorization: Token <access token>`.'