{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}
Webhooks
Create a webhook
Registers a webhook for one event type. Deliveries start with the next matching event for the key owner’s notes and documents. url must be HTTPS on a public host. Requires the webhooks:write scope.
POST
/
webhooks
Create a webhook
curl --request POST \ --url https://api.healos.ai/ext-api/v1/webhooks \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data '{ "name": "EHR sync", "url": "https://hooks.example.com/healos", "event_type": "NOTE_CREATED", "format": "JSON", "description": "Pushes new notes to our EHR bridge", "headers": { "Authorization": "Bearer your-shared-secret" }}'
{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}
Requirement
Detail
Scope
webhooks:write
Rate limit
About 60 requests per minute per API key (shared by all endpoints; approximate)
Cost
Free
Safety
Writes data: Yes. Registers a webhook. HealOS starts sending events to url with the next matching note or document event.
Safe to retry: Only with an Idempotency-Key header: a repeat with the same key returns the first webhook instead of a second one.
Contacts an outside system: Not at creation. Later deliveries POST to your url.
Dry run: Not available.
Rolling out: this endpoint is on staging first and not yet on api.healos.ai.
One webhook receives one event_type; create one per event you need. url must be HTTPS on a public host (loopback, private, link-local and cloud-metadata addresses are rejected, at creation and again before every delivery).Use headers to send a shared secret your endpoint checks, for example {"Authorization": "Bearer <secret>"}. Host, Content-Type, Content-Length, User-Agent and other framing headers are set by HealOS and cannot be configured. Header values cannot be read back, so keep your copy.Webhooks belong to the user who created the API key and receive that user’s note and document events, the same as on the dashboard’s Webhooks page. A webhook of another user, in your organization or any other, is a 404.Guide: Webhooks. Errors: Error catalog.
Makes a retry of this request safe. A repeat with the same key and the same request within 24 hours does not run again: it returns the original status with the resource as it is now, and an Idempotent-Replayed: true header. Keys are scoped to your organization and API key. See https://docs.healos.ai/idempotency.
Up to 255 printable ASCII characters. Use a new random value (a UUID) for each new request and resend the same value when you retry it.
Up to 10 static headers sent with every delivery, for example a shared secret your endpoint checks. Values are write-only: responses list the header names, never the values.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"HealOS Docs","description":"HealOS product guides for AI Scribe and AI Receptionist, plus guides, recipes and the API reference for the HealOS External API.","colors":{"primary":"#6731D7","light":"#8B5CF6","dark":"#5429AE"},"logo":{"light":"https://mintcdn.com/healos/M3Or2eJe4P95ax9C/logo/healos-light.png?fit=max\u0026auto=format\u0026n=M3Or2eJe4P95ax9C\u0026q=85\u0026s=90de1addc301c87e1fe16e86d218b4af","dark":"https://mintcdn.com/healos/M3Or2eJe4P95ax9C/logo/healos-dark.png?fit=max\u0026auto=format\u0026n=M3Or2eJe4P95ax9C\u0026q=85\u0026s=628ea7c8d0d101083267bd36937d327b","href":"https://healos.ai"},"favicon":"https://mintcdn.com/healos/1Zym37w0e99Y6K8x/favicon.png?fit=max\u0026auto=format\u0026n=1Zym37w0e99Y6K8x\u0026q=85\u0026s=750b7a2e719e792188d9e218d8a14c26","api":{"examples":{"languages":["bash","javascript","python"]}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.healos.ai"}},"footer":{"socials":{"website":"https://healos.ai"}},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"healos","hasAudioNarration":false,"actualSubdomain":"healos","customDomains":["docs.healos.ai"],"gitSource":{"type":"github","owner":"medinoteorg","repo":"healos","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":"","_id":"6ae4e1c72e0ec70f4fd8287b"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af2d49010b1a0d7de1300dd","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":64},{"language":"default","tag":"API Guides","count":56},{"language":"default","tag":"EHR Integrations","count":32},{"language":"default","tag":"Using HealOS","count":24},{"language":"default","tag":"AI Receptionist","count":11},{"language":"default","tag":"AI Scribe","count":10},{"language":"default","tag":"Notes","count":9},{"language":"default","tag":"Receptionist","count":8},{"language":"default","tag":"Get Started","count":8},{"language":"default","tag":"Fax","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/webhooks/create-a-webhook","slug":"/api-reference/webhooks/create-a-webhook","pageMetadata":{"openapi":"openapi/ext-api-v1.json POST /webhooks","title":"Create a webhook","description":"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner's notes and documents. `url` must be HTTPS on a public host. Requires the webhooks:write scope.","href":"/api-reference/webhooks/create-a-webhook"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner’s notes and documents. \", _jsx(_components.code, {\n children: \"url\"\n }), \" must be HTTPS on a public host. Requires the webhooks:write scope.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Note,Table}=_components;if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Requirement`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Scope`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`webhooks:write`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Rate limit`})}),_jsx(_components.td,{children:`About 60 requests per minute per API key (shared by all endpoints; approximate)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Cost`})}),_jsx(_components.td,{children:`Free`})]})]})]}),`\n`,_jsxs(Note,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Safety`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Writes data:`}),` Yes. Registers a webhook. HealOS starts sending events to `,_jsx(_components.code,{children:`url`}),` with the next matching note or document event.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Safe to retry:`}),` Only with an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header: a repeat with the same key returns the first webhook instead of a second one.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Contacts an outside system:`}),` Not at creation. Later deliveries POST to your `,_jsx(_components.code,{children:`url`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Dry run:`}),` Not available.`]}),`\n`]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Rolling out: this endpoint is on staging first and not yet on `,_jsx(_components.code,{children:`api.healos.ai`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`One webhook receives one `,_jsx(_components.code,{children:`event_type`}),`; create one per event you need. `,_jsx(_components.code,{children:`url`}),` must be HTTPS on a public host (loopback, private, link-local and cloud-metadata addresses are rejected, at creation and again before every delivery).`]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`headers`}),` to send a shared secret your endpoint checks, for example `,_jsx(_components.code,{children:`{\"Authorization\": \"Bearer \u003csecret>\"}`}),`. `,_jsx(_components.code,{children:`Host`}),`, `,_jsx(_components.code,{children:`Content-Type`}),`, `,_jsx(_components.code,{children:`Content-Length`}),`, `,_jsx(_components.code,{children:`User-Agent`}),` and other framing headers are set by HealOS and cannot be configured. Header values cannot be read back, so keep your copy.`]}),`\n`,_jsxs(_components.p,{children:[`Webhooks belong to the user who created the API key and receive that user’s note and document events, the same as on the dashboard’s Webhooks page. A webhook of another user, in your organization or any other, is a `,_jsx(_components.code,{children:`404`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Guide: `,_jsx(_components.a,{href:`/webhooks`,children:`Webhooks`}),`. Errors: `,_jsx(_components.a,{href:`/errors`,children:`Error catalog`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"openapi/ext-api-v1.json POST /webhooks","title":"Create a webhook","description":"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner's notes and documents. `url` must be HTTPS on a public host. Requires the webhooks:write scope.","href":"/api-reference/webhooks/create-a-webhook"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Webhooks"],"summary":"Create a webhook","description":"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner's notes and documents. `url` must be HTTPS on a public host. Requires the webhooks:write scope.","requestBody":"fee1e5fa-d4df-4b76-90df-5f8b0bbc9d0b","responses":{"201":"c95e74a1-80c2-4003-8cee-717827f9809c","400":"557f6e86-c8e3-4d42-a39a-d98d71e5b44e","401":"a21b552d-445b-4fca-b779-15ca74bc9bcb","403":"5dbd42d2-d2ac-49ed-afbf-a50be0187175","409":"3311c1de-db7c-494e-aa3a-4f504d5f2177","422":"263b7122-cb0f-470b-aa2e-b1f14e3b0d50","429":"d7e52944-da6f-465f-9117-dccda54bcbcf"},"parameters":["7164221a-0573-4c89-a3d9-9dcf140ff062"],"method":"post","type":"path","servers":["a92d3741-dd38-4df3-b5dc-86f2ddc4f4bb","10214492-4974-49fd-b287-2cb6d30ebc92"],"security":["b356c10e-7bfb-49bf-bf0d-be98d19bb20a"],"path":"/webhooks","baseUrlOptions":["https://api.healos.ai/ext-api/v1","http://localhost:8787/ext-api/v1"],"title":"Create a webhook","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7164221a-0573-4c89-a3d9-9dcf140ff062":{"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Makes a retry of this request safe. A repeat with the same key and the same request within 24 hours does not run again: it returns the original status with the resource as it is now, and an `Idempotent-Replayed: true` header. Keys are scoped to your organization and API key. See https://docs.healos.ai/idempotency.\nUp to 255 printable ASCII characters. Use a new random value (a UUID) for each new request and resend the same value when you retry it.","example":"5f0c3a8e-2b7d-4c1e-9a64-0d3f2e1b7c90","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"Idempotency-Key","in":"header","description":"Makes a retry of this request safe. A repeat with the same key and the same request within 24 hours does not run again: it returns the original status with the resource as it is now, and an `Idempotent-Replayed: true` header. Keys are scoped to your organization and API key. See https://docs.healos.ai/idempotency."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"example":"EHR sync","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"url":{"type":"string","maxLength":2048,"format":"uri","description":"Your HTTPS endpoint. It must resolve to a public host: loopback, private, link-local and cloud-metadata addresses are rejected.","example":"https://hooks.example.com/healos","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"event_type":{"type":"string","enum":["NOTE_CREATED","NOTE_REGENERATED","NOTE_UPDATED","DOCUMENT_STATUS_CHANGED"],"description":"The event this webhook receives. One event per webhook.","example":"NOTE_CREATED","isRequired":true,"uniqueKey":"event_type","typeLabel":"enum\u003cstring>"},"format":{"type":"string","enum":["JSON","XML","Form Data"],"description":"How the payload is encoded. Default `JSON`.","example":"JSON","uniqueKey":"format","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","maxLength":1000,"example":"Pushes new notes to our EHR bridge","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":1000,"example":"Pushes new notes to our EHR bridge","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"headers.additionalProperties","typeLabel":"string"},"description":"Up to 10 static headers sent with every delivery, for example a shared secret your endpoint checks. Values are write-only: responses list the header names, never the values.","example":{"Authorization":"Bearer your-shared-secret"},"uniqueKey":"headers","typeLabel":"object"}},"required":["name","url","event_type"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"EHR sync","url":"https://hooks.example.com/healos","event_type":"NOTE_CREATED","format":"JSON","description":"Pushes new notes to our EHR bridge","headers":{"Authorization":"Bearer your-shared-secret"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c95e74a1-80c2-4003-8cee-717827f9809c":{"description":"Webhook created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","example":"3f2b8c1e-0000-4000-8000-000000000001","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.url","typeLabel":"string"},"event_type":{"type":"string","example":"NOTE_CREATED","isRequired":true,"uniqueKey":"data.event_type","typeLabel":"string"},"format":{"type":"string","example":"JSON","isRequired":true,"uniqueKey":"data.format","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.description","typeLabel":"string | null"},"header_names":{"type":"array","items":{"type":"string","uniqueKey":"data.header_names.items.[INDEX]","typeLabel":"string"},"description":"The names of the configured headers. Their values are never returned.","example":["Authorization"],"isRequired":true,"uniqueKey":"data.header_names","typeLabel":"string[]"},"active":{"type":"boolean","isRequired":true,"uniqueKey":"data.active","typeLabel":"boolean"},"created_at":{"type":"string","example":"2026-11-03T14:00:00.000Z","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string"}},"required":["id","name","url","event_type","format","description","header_names","active","created_at"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3f2b8c1e-0000-4000-8000-000000000001","name":"\u003cstring>","url":"\u003cstring>","event_type":"NOTE_CREATED","format":"JSON","description":"\u003cstring>","header_names":["Authorization"],"active":true,"created_at":"2026-11-03T14:00:00.000Z"}}}},"exampleType":"generated"}},"headers":{"Idempotent-Replayed":{"description":"`true` when this response is a replay of an earlier request with the same `Idempotency-Key`.","schema":{"type":"string","enum":["true"]}}},"exampleType":"generated"},"557f6e86-c8e3-4d42-a39a-d98d71e5b44e":{"description":"Validation error: an unknown event type or format, a URL that is not HTTPS on a public host, a reserved or malformed header, or an unknown field; or `Idempotency-Key` is empty, longer than 255 characters or not printable ASCII","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.details.additionalProperties","typeLabel":"string[]"},"uniqueKey":"oneOf.0.details","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"string"},"code":{"type":"string","enum":["idempotency_key_invalid","idempotency_in_progress","idempotency_key_reused","idempotency_resource_gone"],"isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"a21b552d-445b-4fca-b779-15ca74bc9bcb":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5dbd42d2-d2ac-49ed-afbf-a50be0187175":{"description":"Insufficient scope (needs webhooks:write)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3311c1de-db7c-494e-aa3a-4f504d5f2177":{"description":"You already have 25 webhooks; delete one first; or a request with this `Idempotency-Key` is still being processed (`idempotency_in_progress`; retry after `Retry-After`)","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"string"},"code":{"type":"string","enum":["idempotency_key_invalid","idempotency_in_progress","idempotency_key_reused","idempotency_resource_gone"],"isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"263b7122-cb0f-470b-aa2e-b1f14e3b0d50":{"description":"This `Idempotency-Key` was already used for a different request (`idempotency_key_reused`)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["idempotency_key_invalid","idempotency_in_progress","idempotency_key_reused","idempotency_resource_gone"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"idempotency_key_invalid"}}},"exampleType":"generated"}},"exampleType":"generated"},"d7e52944-da6f-465f-9117-dccda54bcbcf":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Rate limit exceeded. Please retry after the window resets.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["daily_cap_reached"],"description":"Set when the organization reached its daily cap for this paid operation (not on a per-minute limit).","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"reset_at":{"type":"string","format":"date-time","description":"With `code`: when the daily cap resets (next 00:00 UTC).","example":"2026-10-28T00:00:00.000Z","uniqueKey":"reset_at","typeLabel":"string\u003cdate-time>"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Rate limit exceeded. Please retry after the window resets.","code":"daily_cap_reached","reset_at":"2026-10-28T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b356c10e-7bfb-49bf-bf0d-be98d19bb20a":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key obtained from /api/v1/ext-api-keys","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"a92d3741-dd38-4df3-b5dc-86f2ddc4f4bb":{"url":"https://api.healos.ai/ext-api/v1","description":"Production"},"10214492-4974-49fd-b287-2cb6d30ebc92":{"url":"http://localhost:8787/ext-api/v1","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key obtained from /api/v1/ext-api-keys","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key obtained from /api/v1/ext-api-keys","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/ext-api-v1.json"},"subdomain":"healos","siteName":"HealOS Docs","title":"Create a webhook - HealOS Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T21:06:57.835Z","originalFileLocation":"api-reference/webhooks/create-a-webhook.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner\u0026#x27;s notes and documents. url must be HTTPS on a public host. Requires the webhooks:write scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HealOS Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a webhook - HealOS Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner\u0026#x27;s notes and documents. url must be HTTPS on a public host. Requires the webhooks:write scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HealOS Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://healos.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+a+webhook\u0026amp;description=Registers+a+webhook+for+one+event+type.+Deliveries+start+with+the+next+matching+event+for+the+key+owner%27s+notes+and+documents.+%60url%60+must+be+HTTPS+on+a+public+h\u0026amp;theme=49307a7035225162b4a02b71\u0026amp;signature=e3556fcdcf5671b039ee00671c367daa9065d62d25e27b1863c35ba4a98e0e31\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a webhook - HealOS Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner\u0026#x27;s notes and documents. url must be HTTPS on a public host. Requires the webhooks:write scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://healos.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+a+webhook\u0026amp;description=Registers+a+webhook+for+one+event+type.+Deliveries+start+with+the+next+matching+event+for+the+key+owner%27s+notes+and+documents.+%60url%60+must+be+HTTPS+on+a+public+h\u0026amp;theme=49307a7035225162b4a02b71\u0026amp;signature=e3556fcdcf5671b039ee00671c367daa9065d62d25e27b1863c35ba4a98e0e31\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HealOS Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6731D7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/create-a-webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.healos.ai/#organization\",\"name\":\"HealOS Docs\",\"url\":\"https://docs.healos.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/healos/M3Or2eJe4P95ax9C/logo/healos-light.png?fit=max\u0026auto=format\u0026n=M3Or2eJe4P95ax9C\u0026q=85\u0026s=90de1addc301c87e1fe16e86d218b4af\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.healos.ai#website\",\"name\":\"HealOS Docs\",\"url\":\"https://docs.healos.ai\",\"publisher\":{\"@id\":\"https://docs.healos.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook#webpage\",\"url\":\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook\",\"name\":\"Create a webhook\",\"description\":\"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner's notes and documents. url must be HTTPS on a public host. Requires the webhooks:write scope.\",\"dateModified\":\"2026-11-05T21:06:57.835Z\",\"isPartOf\":{\"@id\":\"https://docs.healos.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.healos.ai/api-reference/webhooks/list-webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a webhook\",\"item\":\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook#apireference\",\"headline\":\"Create a webhook\",\"name\":\"Create a webhook\",\"description\":\"Registers a webhook for one event type. Deliveries start with the next matching event for the key owner's notes and documents. url must be HTTPS on a public host. Requires the webhooks:write scope.\",\"url\":\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.healos.ai/api-reference/webhooks/create-a-webhook#webpage\"},\"dateModified\":\"2026-11-05T21:06:57.835Z\",\"publisher\":{\"@id\":\"https://docs.healos.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.healos.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HealOS Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"HealOS Docs","nav":{"global":null,"tabs":[{"tab":"Using HealOS","pages":[{"title":"Using HealOS","href":"/guides/scribe/overview"}]},{"tab":"API Guides","pages":[{"title":"API Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference"}]},{"group":"Account","pages":[{"openapi":"openapi/ext-api-v1.json GET /me","title":"Describe the calling API key","href":"/api-reference/account/describe-the-calling-api-key"}]},{"group":"Patients","pages":[{"openapi":"openapi/ext-api-v1.json GET /patients","title":"List patients","href":"/api-reference/patients/list-patients"},{"openapi":"openapi/ext-api-v1.json POST /patients","title":"Create a new patient","href":"/api-reference/patients/create-a-new-patient"},{"openapi":"openapi/ext-api-v1.json GET /patients/{patientId}","title":"Get patient by ID","href":"/api-reference/patients/get-patient-by-id"},{"openapi":"openapi/ext-api-v1.json PATCH /patients/{patientId}","title":"Update a patient","href":"/api-reference/patients/update-a-patient"},{"openapi":"openapi/ext-api-v1.json DELETE /patients/{patientId}","title":"Delete a patient","href":"/api-reference/patients/delete-a-patient"}]},{"group":"Documents","pages":[{"openapi":"openapi/ext-api-v1.json GET /patients/{patientId}/documents","title":"List patient documents","href":"/api-reference/documents/list-patient-documents"},{"openapi":"openapi/ext-api-v1.json POST /patients/{patientId}/documents","title":"Upload a document","href":"/api-reference/documents/upload-a-document"},{"openapi":"openapi/ext-api-v1.json DELETE /patients/{patientId}/documents/{documentId}","title":"Delete a document","href":"/api-reference/documents/delete-a-document"},{"openapi":"openapi/ext-api-v1.json POST /patients/{patientId}/documents/{documentId}/extract","title":"Extract or retry document text extraction","href":"/api-reference/documents/extract-or-retry-document-text-extraction"}]},{"group":"Appointments","pages":[{"openapi":"openapi/ext-api-v1.json GET /appointments","title":"List appointments","href":"/api-reference/appointments/list-appointments"},{"openapi":"openapi/ext-api-v1.json POST /appointments","title":"Create an appointment","href":"/api-reference/appointments/create-an-appointment"},{"openapi":"openapi/ext-api-v1.json GET /appointments/{appointmentId}","title":"Get appointment by ID","href":"/api-reference/appointments/get-appointment-by-id"},{"openapi":"openapi/ext-api-v1.json PATCH /appointments/{appointmentId}","title":"Update an appointment","href":"/api-reference/appointments/update-an-appointment"},{"openapi":"openapi/ext-api-v1.json DELETE /appointments/{appointmentId}","title":"Delete an appointment","href":"/api-reference/appointments/delete-an-appointment"}]},{"group":"Providers","pages":[{"openapi":"openapi/ext-api-v1.json GET /providers","title":"List providers","href":"/api-reference/providers/list-providers"},{"openapi":"openapi/ext-api-v1.json GET /providers/{providerId}","title":"Get provider by ID","href":"/api-reference/providers/get-provider-by-id"}]},{"group":"Notes","pages":[{"openapi":"openapi/ext-api-v1.json POST /patients/{patientId}/notes/from-documents","title":"Generate a note from the patient's documents","href":"/api-reference/notes/generate-a-note-from-the-patients-documents"},{"openapi":"openapi/ext-api-v1.json GET /notes","title":"List clinical notes","href":"/api-reference/notes/list-clinical-notes"},{"openapi":"openapi/ext-api-v1.json GET /notes/{noteId}","title":"Get a clinical note by ID","href":"/api-reference/notes/get-a-clinical-note-by-id"},{"openapi":"openapi/ext-api-v1.json GET /notes/export","title":"Export clinical notes","href":"/api-reference/notes/export-clinical-notes"},{"openapi":"openapi/ext-api-v1.json GET /sessions/{sessionId}/notes","title":"List notes for a session","href":"/api-reference/notes/list-notes-for-a-session"},{"openapi":"openapi/ext-api-v1.json POST /sessions/{sessionId}/notes/regenerate","title":"Regenerate the note for a session","href":"/api-reference/notes/regenerate-the-note-for-a-session"},{"openapi":"openapi/ext-api-v1.json PATCH /sessions/{sessionId}","title":"Assign a patient to a session","href":"/api-reference/notes/assign-a-patient-to-a-session"},{"openapi":"openapi/ext-api-v1.json POST /notes/from-text","title":"Generate a note from text","href":"/api-reference/notes/generate-a-note-from-text"},{"openapi":"openapi/ext-api-v1.json POST /notes/from-audio","title":"Generate a note from an audio file","href":"/api-reference/notes/generate-a-note-from-an-audio-file"}]},{"group":"Sessions","pages":[{"openapi":"openapi/ext-api-v1.json GET /sessions/{sessionId}","title":"Get session details","href":"/api-reference/sessions/get-session-details"},{"openapi":"openapi/ext-api-v1.json DELETE /sessions/{sessionId}","title":"Delete a session","href":"/api-reference/sessions/delete-a-session"},{"openapi":"openapi/ext-api-v1.json POST /sessions/{sessionId}/restore","title":"Restore a deleted session","href":"/api-reference/sessions/restore-a-deleted-session"}]},{"group":"Templates","pages":[{"openapi":"openapi/ext-api-v1.json GET /templates","title":"List templates","href":"/api-reference/templates/list-templates"},{"openapi":"openapi/ext-api-v1.json GET /templates/{templateId}","title":"Get a template","href":"/api-reference/templates/get-a-template"}]},{"group":"Settings","pages":[{"openapi":"openapi/ext-api-v1.json GET /settings/notes","title":"Get note settings","href":"/api-reference/settings/get-note-settings"}]},{"group":"Fax","pages":[{"openapi":"openapi/ext-api-v1.json GET /faxes","title":"List received faxes","href":"/api-reference/fax/list-received-faxes"},{"openapi":"openapi/ext-api-v1.json GET /faxes/{faxId}","title":"Get a received fax","href":"/api-reference/fax/get-a-received-fax"},{"openapi":"openapi/ext-api-v1.json GET /faxes/{faxId}/file","title":"Download a received fax","href":"/api-reference/fax/download-a-received-fax"},{"openapi":"openapi/ext-api-v1.json GET /faxes/outbound","title":"List sent faxes","href":"/api-reference/fax/list-sent-faxes"},{"openapi":"openapi/ext-api-v1.json GET /faxes/outbound/{outboundFaxId}","title":"Get a sent fax","href":"/api-reference/fax/get-a-sent-fax"}]},{"group":"Benefits","pages":[{"openapi":"openapi/ext-api-v1.json POST /benefits/eligibility-checks","title":"Run an eligibility check","href":"/api-reference/benefits/run-an-eligibility-check"},{"openapi":"openapi/ext-api-v1.json GET /benefits/eligibility-checks","title":"List eligibility checks","href":"/api-reference/benefits/list-eligibility-checks"},{"openapi":"openapi/ext-api-v1.json GET /benefits/eligibility-checks/{checkId}","title":"Get an eligibility check","href":"/api-reference/benefits/get-an-eligibility-check"},{"openapi":"openapi/ext-api-v1.json GET /benefits/payers/search","title":"Search payers","href":"/api-reference/benefits/search-payers"}]},{"group":"Prior Auth","pages":[{"openapi":"openapi/ext-api-v1.json GET /prior-auth/requests","title":"List prior-auth requests","href":"/api-reference/prior-auth/list-prior-auth-requests"},{"openapi":"openapi/ext-api-v1.json GET /prior-auth/requests/{requestId}","title":"Get a prior-auth request","href":"/api-reference/prior-auth/get-a-prior-auth-request"},{"openapi":"openapi/ext-api-v1.json GET /prior-auth/requests/{requestId}/events","title":"List a request's events","href":"/api-reference/prior-auth/list-a-requests-events"},{"openapi":"openapi/ext-api-v1.json GET /prior-auth/workflows","title":"List prior-auth workflows","href":"/api-reference/prior-auth/list-prior-auth-workflows"},{"openapi":"openapi/ext-api-v1.json POST /prior-auth/status-checks","title":"Check Availity decisions now","href":"/api-reference/prior-auth/check-availity-decisions-now"}]},{"group":"EHR","pages":[{"openapi":"openapi/ext-api-v1.json GET /ehr/actions","title":"List EHR actions","href":"/api-reference/ehr/list-ehr-actions"},{"openapi":"openapi/ext-api-v1.json GET /ehr/actions/{actionName}","title":"Get an EHR action","href":"/api-reference/ehr/get-an-ehr-action"},{"openapi":"openapi/ext-api-v1.json GET /ehr/connections","title":"List your EHR connections","href":"/api-reference/ehr/list-your-ehr-connections"}]},{"group":"Receptionist","pages":[{"openapi":"openapi/ext-api-v1.json GET /receptionist/calls","title":"List receptionist calls","href":"/api-reference/receptionist/list-receptionist-calls"},{"openapi":"openapi/ext-api-v1.json GET /receptionist/calls/{callId}","title":"Get a receptionist call","href":"/api-reference/receptionist/get-a-receptionist-call"},{"openapi":"openapi/ext-api-v1.json GET /receptionist/calls/{callId}/recording","title":"Download a call recording","href":"/api-reference/receptionist/download-a-call-recording"},{"openapi":"openapi/ext-api-v1.json GET /receptionist/tasks","title":"List receptionist tasks","href":"/api-reference/receptionist/list-receptionist-tasks"},{"openapi":"openapi/ext-api-v1.json GET /receptionist/tasks/{taskId}","title":"Get a receptionist task","href":"/api-reference/receptionist/get-a-receptionist-task"},{"openapi":"openapi/ext-api-v1.json POST /receptionist/tasks","title":"Create a receptionist task","href":"/api-reference/receptionist/create-a-receptionist-task"},{"openapi":"openapi/ext-api-v1.json PATCH /receptionist/tasks/{taskId}","title":"Update a receptionist task","href":"/api-reference/receptionist/update-a-receptionist-task"},{"openapi":"openapi/ext-api-v1.json DELETE /receptionist/tasks/{taskId}","title":"Delete a receptionist task","href":"/api-reference/receptionist/delete-a-receptionist-task"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/ext-api-v1.json GET /webhooks","title":"List webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"openapi/ext-api-v1.json GET /webhooks/{webhookId}","title":"Get a webhook","description":"One of your webhooks. Another user's webhook is a 404. Requires the webhooks:read scope.","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"openapi/ext-api-v1.json POST /webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"openapi/ext-api-v1.json PATCH /webhooks/{webhookId}","title":"Update a webhook","description":"Changes the fields you send. `active: false` pauses deliveries. `headers` replaces every configured header. A new `url` is checked like on create. Another user's webhook is a 404. Requires the webhooks:write scope.","href":"/api-reference/webhooks/update-a-webhook"},{"openapi":"openapi/ext-api-v1.json DELETE /webhooks/{webhookId}","title":"Delete a webhook","href":"/api-reference/webhooks/delete-a-webhook"}]},{"group":"Audit","pages":[{"openapi":"openapi/ext-api-v1.json GET /audit-events","title":"List audit events","href":"/api-reference/audit/list-audit-events"}]}]}]},"basePath":"","title":"Create a webhook - HealOS Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}