The URL that Zeeg will send webhook payloads to. Must be a valid HTTPS URL.
events
enum<string>[]
required
List of event types to subscribe to. routing_form.submitted and
ai_agent.call_completed deliver to organization-scoped webhooks only;
subscribing a user-scoped webhook to either is rejected with a 422.
On an Event page that approves registrations by hand, invitee.scheduled
fires when the host approves the registration.
Available options:
invitee.scheduled,
invitee.cancelled,
invitee.withdrawn,
invitee.no_show,
invitee.handed_over,
routing_form.submitted,
ai_agent.call_completed
scope
enum<string>
required
The scope of the webhook subscription. Use user for personal webhooks or organization for organization-wide webhooks.
Available options:
user,
organization
token
string
Optional verification token. When set, Zeeg includes it in a Token header on every webhook delivery (including the test endpoint). Use it to verify that incoming requests originate from Zeeg.
Must be at least 8 characters and contain only printable, non-whitespace ASCII characters. Leading and trailing whitespace are trimmed automatically.
Required string length: 8 - 1000
Pattern: ^[\x21-\x7E]+$
Response
Created
success
boolean
resource
object
The created webhook.
Hide child attributes
resource.uuid
string<uuid>
resource.name
string | null
resource.description
string | null
resource.callbackUrl
string<uri>
resource.scope
enum<string>
Available options:
user,
organization
resource.creator
object
Hide child attributes
resource.creator.firstName
string
resource.creator.lastName
string
resource.creator.slug
string
resource.events
string[]
resource.organization
string<uuid> | null
The organization's UUID.
resource.apiVersion
string | null
resource.createdAt
string<date-time>
ISO 8601 date-time with offset, in the authenticated user's timezone.
resource.updatedAt
string<date-time>
ISO 8601 date-time with offset, in the authenticated user's timezone.
testResult
object | null
Result of the synthetic test event sent to the callbackUrl. null only when the test was skipped (rare).
Hide child attributes
testResult.delivered
boolean
Whether the callback URL responded with a 2xx status. Always true on a 201 response.
testResult.statusCode
integer | null
HTTP status code returned by the callback URL, or null if the request never reached it.
testResult.error
enum<string> | null
Reason the delivery did not complete. connection_failed and request_failed mean the request never reached the callback URL, and statusCode is null. redirect_not_followed means the callback URL answered with a 3xx that Zeeg does not follow; statusCode holds it, and the fix is to store the final address.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Zeeg Developer Hub","description":"Zeeg Developer Hub: REST API reference, guides, and webhooks for building scheduling, booking, and AI-agent integrations on the Zeeg platform.","colors":{"primary":"#6C63FF","light":"#8B83FF","dark":"#4F46E5"},"logo":"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/Zeeglogo(Original).svg?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=321632804eda4b3cff044941f9ccadda","favicon":"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/favicon.ico?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=ee885974552f141091cdd615c5c15345","api":{"openapi":"openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.zeeg.me/v2"}},"appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"dark":"#0f1117"}},"navbar":{"links":[{"href":"https://app.zeeg.me","label":"Dashboard"}],"primary":{"type":"button","label":"Get API Key","href":"https://app.zeeg.me/account/settings/api-access"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/zeeg","x":"https://www.twitter.com/zeeg_me","youtube":"https://www.youtube.com/@zeeg_me","instagram":"https://www.instagram.com/zeeg.me"},"links":[{"header":"Product","items":[{"label":"Pricing","href":"https://zeeg.me/en/pricing"},{"label":"Help Center","href":"https://zeeg.me/en/help"},{"label":"System Status","href":"https://status.zeeg.me"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"https://zeeg.me/en/legal/terms"},{"label":"Privacy Policy","href":"https://zeeg.me/en/legal/privacy"},{"label":"Imprint","href":"https://zeeg.me/en/legal/imprint"}]}]},"search":{"prompt":"Search endpoints, guides, and more..."},"seo":{"metatags":{"og:site_name":"Zeeg Developer Hub","og:type":"website","og:locale":"en_US","og:url":"https://developer.zeeg.me","twitter:card":"summary_large_image","twitter:site":"@zeeg_me","author":"Zeeg","robots":"index, follow","googlebot":"index, follow"},"indexing":"all"},"fonts":{"family":"Inter"},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"section","latex":false},"integrations":{"gtm":{"tagId":"GTM-5XJGGJP"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. Try the [API Reference](/api/workspaces-teams/check-logged-in-user) or [Quickstart](/quickstart)."}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"schema":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zeeg","hasAudioNarration":false,"actualSubdomain":"zeeg","customDomains":["developer.zeeg.me"],"gitSource":{"type":"github","owner":"zeeg","repo":"api-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b01a0ee0abeee4b6ea228b5","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"default","tag":"API Reference","count":216},{"language":"default","tag":"CRM","count":27},{"language":"default","tag":"Scheduling Pages","count":19},{"language":"default","tag":"Availability Schedule","count":15},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Routing Forms","count":12},{"language":"default","tag":"Workspaces \u0026 Teams","count":12},{"language":"default","tag":"Forms","count":8},{"language":"default","tag":"Documentation","count":8},{"language":"default","tag":"Objects","count":7}],"searchSettings":{"maxResults":10}},"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":"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":"site-roles","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},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api/webhooks/create-webhook-subscription","slug":"/api/webhooks/create-webhook-subscription","pageMetadata":{"title":"Create Webhook Subscription","description":"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.","openapi":"POST /webhooks","href":"/api/webhooks/create-webhook-subscription"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Webhook Subscription","description":"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.","openapi":"POST /webhooks","href":"/api/webhooks/create-webhook-subscription"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create webhook subscription","tags":["Webhooks"],"operationId":"post-webhooks","description":"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.","security":["34efb651-846f-49cb-9038-253f50c470bc"],"requestBody":"23755fb2-c103-4d14-b419-263a624fd672","responses":{"201":"037c022b-3d87-4963-a0ab-07b299f831b4","400":"1fc3bce1-d7b1-4b36-86a7-4d6ec80509fa","401":"2690d125-5dfd-4e78-a165-336bbd6d7598","422":"664edc69-6ab8-4cd4-8408-969105f10360","424":"98ce220d-eb56-43ad-a936-90b87237c689"},"method":"post","type":"path","servers":["dcff1800-0618-4dfd-b78a-57d290938438"],"path":"/webhooks","baseUrlOptions":["https://api.zeeg.me/v2"],"title":"Create webhook subscription","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["callbackUrl","events","scope"],"properties":{"callbackUrl":{"type":"string","format":"uri","description":"The URL that Zeeg will send webhook payloads to. Must be a valid HTTPS URL.","isRequired":true,"uniqueKey":"callbackUrl","typeLabel":"string\u003curi>"},"events":{"type":"array","description":"List of event types to subscribe to. `routing_form.submitted` and\n`ai_agent.call_completed` deliver to `organization`-scoped webhooks only;\nsubscribing a `user`-scoped webhook to either is rejected with a 422.\nOn an Event page that approves registrations by hand, `invitee.scheduled`\nfires when the host approves the registration.","items":{"type":"string","enum":["invitee.scheduled","invitee.cancelled","invitee.withdrawn","invitee.no_show","invitee.handed_over","routing_form.submitted","ai_agent.call_completed"],"uniqueKey":"events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"events","typeLabel":"enum\u003cstring>[]"},"scope":{"type":"string","enum":["user","organization"],"description":"The scope of the webhook subscription. Use `user` for personal webhooks or `organization` for organization-wide webhooks.","isRequired":true,"uniqueKey":"scope","typeLabel":"enum\u003cstring>"},"token":{"type":"string","minLength":8,"maxLength":1000,"pattern":"^[\\x21-\\x7E]+$","description":"Optional verification token. When set, Zeeg includes it in a `Token` header on every webhook delivery (including the test endpoint). Use it to verify that incoming requests originate from Zeeg.\n\nMust be at least 8 characters and contain only printable, non-whitespace ASCII characters. Leading and trailing whitespace are trimmed automatically.","uniqueKey":"token","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"User-scoped webhook":{"title":"User-scoped webhook","value":{"callbackUrl":"https://example.com/webhooks/zeeg","events":["invitee.scheduled","invitee.cancelled"],"scope":"user","token":"my-secret-token-123"}},"Organization-scoped webhook":{"title":"Organization-scoped webhook","value":{"callbackUrl":"https://example.com/webhooks/zeeg-org","events":["invitee.scheduled","invitee.cancelled","routing_form.submitted"],"scope":"organization"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"037c022b-3d87-4963-a0ab-07b299f831b4":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"resource":{"type":"object","description":"The created webhook.","properties":{"uuid":{"type":"string","format":"uuid","uniqueKey":"resource.uuid","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","uniqueKey":"resource.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"resource.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"resource.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"resource.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.description","typeLabel":"string | null"},"callbackUrl":{"type":"string","format":"uri","uniqueKey":"resource.callbackUrl","typeLabel":"string\u003curi>"},"scope":{"type":"string","enum":["user","organization"],"uniqueKey":"resource.scope","typeLabel":"enum\u003cstring>"},"creator":{"type":"object","properties":{"firstName":{"type":"string","uniqueKey":"resource.creator.firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"resource.creator.lastName","typeLabel":"string"},"slug":{"type":"string","uniqueKey":"resource.creator.slug","typeLabel":"string"}},"uniqueKey":"resource.creator","typeLabel":"object"},"events":{"type":"array","items":{"type":"string","uniqueKey":"resource.events.items.[INDEX]","typeLabel":"string"},"uniqueKey":"resource.events","typeLabel":"string[]"},"organization":{"oneOf":[{"type":"string","format":"uuid","description":"The organization's UUID.","uniqueKey":"resource.organization.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The organization's UUID.","uniqueKey":"resource.organization.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.organization","typeLabel":"string\u003cuuid> | null"},"apiVersion":{"oneOf":[{"type":"string","uniqueKey":"resource.apiVersion.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"resource.apiVersion.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.apiVersion","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 date-time with offset, in the authenticated user's timezone.","uniqueKey":"resource.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 date-time with offset, in the authenticated user's timezone.","uniqueKey":"resource.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"resource","typeLabel":"object"},"testResult":{"oneOf":[{"type":"object","description":"Result of the synthetic test event sent to the `callbackUrl`. `null` only when the test was skipped (rare).","properties":{"delivered":{"type":"boolean","description":"Whether the callback URL responded with a 2xx status. Always `true` on a `201` response.","uniqueKey":"testResult.oneOf.0.delivered","typeLabel":"boolean"},"statusCode":{"oneOf":[{"type":"integer","description":"HTTP status code returned by the callback URL, or `null` if the request never reached it.","uniqueKey":"testResult.oneOf.0.statusCode.oneOf.0","typeLabel":"integer"},{"type":"null","description":"HTTP status code returned by the callback URL, or `null` if the request never reached it.","uniqueKey":"testResult.oneOf.0.statusCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"testResult.oneOf.0.statusCode","typeLabel":"integer | null"},"error":{"oneOf":[{"type":"string","enum":["connection_failed","request_failed","redirect_not_followed"],"description":"Reason the delivery did not complete. `connection_failed` and `request_failed` mean the request never reached the callback URL, and `statusCode` is `null`. `redirect_not_followed` means the callback URL answered with a 3xx that Zeeg does not follow; `statusCode` holds it, and the fix is to store the final address.","uniqueKey":"testResult.oneOf.0.error.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["connection_failed","request_failed","redirect_not_followed"],"description":"Reason the delivery did not complete. `connection_failed` and `request_failed` mean the request never reached the callback URL, and `statusCode` is `null`. `redirect_not_followed` means the callback URL answered with a 3xx that Zeeg does not follow; `statusCode` holds it, and the fix is to store the final address.","uniqueKey":"testResult.oneOf.0.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"testResult.oneOf.0.error","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"testResult.oneOf.0","typeLabel":"object"},{"type":"null","description":"Result of the synthetic test event sent to the `callbackUrl`. `null` only when the test was skipped (rare).","properties":{"delivered":{"type":"boolean","description":"Whether the callback URL responded with a 2xx status. Always `true` on a `201` response."},"statusCode":{"oneOf":[{"type":"integer","description":"HTTP status code returned by the callback URL, or `null` if the request never reached it."},{"type":"null","description":"HTTP status code returned by the callback URL, or `null` if the request never reached it."}]},"error":{"oneOf":[{"type":"string","enum":["connection_failed","request_failed","redirect_not_followed"],"description":"Reason the delivery did not complete. `connection_failed` and `request_failed` mean the request never reached the callback URL, and `statusCode` is `null`. `redirect_not_followed` means the callback URL answered with a 3xx that Zeeg does not follow; `statusCode` holds it, and the fix is to store the final address."},{"type":"null","enum":["connection_failed","request_failed","redirect_not_followed"],"description":"Reason the delivery did not complete. `connection_failed` and `request_failed` mean the request never reached the callback URL, and `statusCode` is `null`. `redirect_not_followed` means the callback URL answered with a 3xx that Zeeg does not follow; `statusCode` holds it, and the fix is to store the final address."}]}},"uniqueKey":"testResult.oneOf.1","typeLabel":"null"}],"uniqueKey":"testResult","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Webhook created and test delivered":{"title":"Webhook created and test delivered","value":{"success":true,"resource":{"uuid":"9a39bf60-a6c3-45e7-80cd-2cd36e520861","name":null,"description":null,"callbackUrl":"https://example.com/webhooks/zeeg","scope":"user","creator":{"firstName":"Lena","lastName":"Meier","slug":"lena-meier"},"events":["invitee.scheduled","invitee.cancelled"],"organization":null,"apiVersion":null,"createdAt":"2026-07-09T14:30:00+02:00","updatedAt":"2026-07-09T14:30:00+02:00"},"testResult":{"delivered":true,"statusCode":200,"error":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"1fc3bce1-d7b1-4b36-86a7-4d6ec80509fa":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid request":{"title":"Invalid request","value":{"success":false,"message":"The request is invalid.","status":400}}},"exampleType":"examples"}},"exampleType":"examples"},"2690d125-5dfd-4e78-a165-336bbd6d7598":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthenticated.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Unauthenticated":{"title":"Unauthenticated","value":{"message":"Unauthenticated."}}},"exampleType":"examples"}},"exampleType":"examples"},"664edc69-6ab8-4cd4-8408-969105f10360":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","uniqueKey":"errors.events.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.events","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Missing events":{"title":"Missing events","value":{"message":"The events field is required.","errors":{"events":["The events field is required."]}}}},"exampleType":"examples"}},"exampleType":"examples"},"98ce220d-eb56-43ad-a936-90b87237c689":{"description":"Failed Dependency. The synthetic test event sent to your `callbackUrl` did not deliver, so the webhook was not created. Inspect `testResult` to see whether the callback responded with a non-2xx status (`statusCode`), redirected (`error: redirect_not_followed`), or could not be reached at all (`error`). Fix your endpoint and re-issue the request.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"},"resource":{"oneOf":[{"type":"object","uniqueKey":"resource.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"resource.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource","typeLabel":"object | null"},"testResult":{"type":"object","properties":{"delivered":{"type":"boolean","uniqueKey":"testResult.delivered","typeLabel":"boolean"},"statusCode":{"oneOf":[{"type":"integer","uniqueKey":"testResult.statusCode.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"testResult.statusCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"testResult.statusCode","typeLabel":"integer | null"},"error":{"oneOf":[{"type":"string","enum":["connection_failed","request_failed","redirect_not_followed"],"uniqueKey":"testResult.error.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["connection_failed","request_failed","redirect_not_followed"],"uniqueKey":"testResult.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"testResult.error","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"testResult","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Test rejected":{"title":"Test rejected","value":{"success":false,"status":424,"resource":null,"testResult":{"delivered":false,"statusCode":500,"error":null}}},"Endpoint unreachable":{"title":"Endpoint unreachable","value":{"success":false,"status":424,"resource":null,"testResult":{"delivered":false,"statusCode":null,"error":"connection_failed"}}},"Endpoint redirects":{"title":"Endpoint redirects","value":{"success":false,"status":424,"resource":null,"testResult":{"delivered":false,"statusCode":301,"error":"redirect_not_followed"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"34efb651-846f-49cb-9038-253f50c470bc":{"bearer":{"type":"http","scheme":"bearer","description":"","scopes":[],"schemeName":"bearer"}}},"servers":{"dcff1800-0618-4dfd-b78a-57d290938438":{"url":"https://api.zeeg.me/v2","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"zeeg","siteName":"Zeeg Developer Hub","title":"Create Webhook Subscription - Zeeg Developer Hub","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-29T14:35:49.175Z","gitLastModified":"2026-04-29T14:35:30.000Z","originalFileLocation":"api/webhooks/create-webhook-subscription.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=\"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_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/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_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/zeeg/ghjkS0QJHhQPDpab/_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/zeeg/ghjkS0QJHhQPDpab/_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/zeeg/ghjkS0QJHhQPDpab/_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/zeeg/ghjkS0QJHhQPDpab/_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/zeeg/ghjkS0QJHhQPDpab/_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/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Webhook Subscription - Zeeg Developer Hub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zeeg.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+Webhook+Subscription\u0026amp;description=Register+a+webhook+callback+URL+to+receive+real-time+notifications+for+selected+Zeeg+events+such+as+bookings%2C+cancellations%2C+and+reschedules.\u0026amp;theme=902e11371c50c4af37ea8b4f\u0026amp;signature=67f0a1f1758bb87f69b066fcd5e89d15cfef197d46ee93442a709d31361a5025\">\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 Webhook Subscription - Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zeeg.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+Webhook+Subscription\u0026amp;description=Register+a+webhook+callback+URL+to+receive+real-time+notifications+for+selected+Zeeg+events+such+as+bookings%2C+cancellations%2C+and+reschedules.\u0026amp;theme=902e11371c50c4af37ea8b4f\u0026amp;signature=67f0a1f1758bb87f69b066fcd5e89d15cfef197d46ee93442a709d31361a5025\">\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/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6C63FF\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Zeeg\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/webhooks/create-webhook-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.zeeg.me/#organization\",\"name\":\"Zeeg Developer Hub\",\"url\":\"https://developer.zeeg.me\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/Zeeglogo(Original).svg?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=321632804eda4b3cff044941f9ccadda\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.zeeg.me#website\",\"name\":\"Zeeg Developer Hub\",\"url\":\"https://developer.zeeg.me\",\"publisher\":{\"@id\":\"https://developer.zeeg.me/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription#webpage\",\"url\":\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription\",\"name\":\"Create Webhook Subscription\",\"description\":\"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.\",\"dateModified\":\"2026-04-29T14:35:30.000Z\",\"isPartOf\":{\"@id\":\"https://developer.zeeg.me#website\"},\"breadcrumb\":{\"@id\":\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developer.zeeg.me/api/scheduled-events/list-scheduled-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Webhook Subscription\",\"item\":\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription#apireference\",\"headline\":\"Create Webhook Subscription\",\"name\":\"Create Webhook Subscription\",\"description\":\"Register a webhook callback URL to receive real-time notifications for selected Zeeg events such as bookings, cancellations, and reschedules.\",\"url\":\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://developer.zeeg.me/api/webhooks/create-webhook-subscription#webpage\"},\"dateModified\":\"2026-04-29T14:35:30.000Z\",\"publisher\":{\"@id\":\"https://developer.zeeg.me/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.zeeg.me#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zeeg Developer Hub\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Zeeg Developer Hub\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/webhooks/create-webhook-subscription.md","siteName":"Zeeg Developer Hub","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/booking-flow"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"group":"Scheduled Events","expanded":false,"pages":[{"title":"List Scheduled Events","openapi":"GET /scheduled-events","href":"/api/scheduled-events/list-scheduled-events"},{"title":"Get a Scheduled Event","openapi":"GET /scheduled-events/{uuid}","href":"/api/scheduled-events/get-a-scheduled-event"},{"title":"Get Reschedule Availability","openapi":"GET /scheduled-events/{uuid}/reschedule-availability","href":"/api/scheduled-events/get-reschedule-availability"},{"title":"Reschedule a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/reschedule","href":"/api/scheduled-events/reschedule-a-scheduled-event"},{"title":"Cancel a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/cancel","href":"/api/scheduled-events/cancel-a-scheduled-event"},{"title":"Cancel a Scheduled Invitee","openapi":"PUT /scheduled-invitees/{uuid}/cancel","href":"/api/scheduled-events/cancel-a-scheduled-invitee"},{"title":"Handover a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/handover","href":"/api/scheduled-events/handover-a-scheduled-event"}]},{"group":"Scheduling Pages","expanded":false,"pages":[{"title":"List Scheduling Pages","openapi":"GET /event-types","href":"/api/scheduling-pages/list-scheduling-pages"},{"title":"Get a Scheduling Page","openapi":"GET /event-types/{uuid}","href":"/api/scheduling-pages/get-a-scheduling-page"},{"title":"Create a Scheduling Page","openapi":"POST /event-types","href":"/api/scheduling-pages/create-a-scheduling-page"},{"title":"Update a Scheduling Page","openapi":"PATCH /event-types/{uuid}","href":"/api/scheduling-pages/update-a-scheduling-page"},{"title":"Duplicate a Scheduling Page","openapi":"POST /event-types/{uuid}/duplicate","href":"/api/scheduling-pages/duplicate-a-scheduling-page"},{"title":"Delete a Scheduling Page","openapi":"DELETE /event-types/{uuid}","href":"/api/scheduling-pages/delete-a-scheduling-page"},{"title":"Get Scheduling Page Questions","openapi":"GET /event-types/{uuid}/questions","href":"/api/scheduling-pages/get-scheduling-page-questions"},{"title":"Replace Scheduling Page Questions","openapi":"PUT /event-types/{uuid}/questions","href":"/api/scheduling-pages/replace-scheduling-page-questions"},{"title":"Get Scheduling Page Notifications","openapi":"GET /event-types/{uuid}/notifications","href":"/api/scheduling-pages/get-scheduling-page-notifications"},{"title":"Update Scheduling Page Notifications","openapi":"PATCH /event-types/{uuid}/notifications","href":"/api/scheduling-pages/update-scheduling-page-notifications"},{"title":"Toggle Scheduling Page Status","openapi":"PUT /event-types/{uuid}/status","href":"/api/scheduling-pages/toggle-scheduling-page-status"},{"title":"List Event Page Dates","openapi":"GET /event-types/{uuid}/sessions","href":"/api/scheduling-pages/list-event-page-dates"},{"title":"Add Event Page Dates","openapi":"POST /event-types/{uuid}/sessions","href":"/api/scheduling-pages/add-event-page-dates"},{"title":"Change an Event Page Date","openapi":"PUT /event-types/{uuid}/sessions/{sessionUuid}","href":"/api/scheduling-pages/update-an-event-page-date"},{"title":"Remove an Event Page Date","openapi":"DELETE /event-types/{uuid}/sessions/{sessionUuid}","href":"/api/scheduling-pages/delete-an-event-page-date"},{"title":"Get a Single-Use Scheduling Link","openapi":"GET /event-types/{uuid}/single-use-link","href":"/api/scheduling-pages/get-a-single-use-scheduling-link"},{"title":"Get Available Time Slots","openapi":"GET /availability/{ownerSlug}/event-types/{eventTypeSlug}","href":"/api/scheduling-pages/get-available-time-slots"},{"title":"Get Available Time Slots by ID","openapi":"GET /event-types/{uuid}/availability","href":"/api/scheduling-pages/get-available-time-slots-by-id"},{"title":"Create an Event","openapi":"POST /event","href":"/api/scheduling-pages/create-an-event"}]},{"group":"Availability Schedule","expanded":false,"pages":[{"title":"Get All Availability Schedules","openapi":"GET /schedules","href":"/api/availability/get-all-availability-schedules"},{"title":"Get Default Availability Schedule","openapi":"GET /schedules/default","href":"/api/availability/get-default-availability-schedule"},{"title":"Update Default Availability Schedule","openapi":"PATCH /schedules/default","href":"/api/availability/update-default-availability-schedule"},{"title":"Get Availability Schedule by UUID","openapi":"GET /schedules/{uuid}","href":"/api/availability/get-availability-schedule-by-uuid"},{"title":"Update Availability Schedule by UUID","openapi":"PATCH /schedules/{uuid}","href":"/api/availability/update-availability-schedule-by-uuid"},{"title":"List Time-Off Periods","openapi":"GET /time-off","href":"/api/availability/list-time-off-periods"},{"title":"Create Time-Off Periods","openapi":"POST /time-off","href":"/api/availability/create-time-off-periods"},{"title":"Update Time-Off Period","openapi":"PATCH /time-off/{uuid}","href":"/api/availability/update-time-off-period"},{"title":"Delete Time-Off Period","openapi":"DELETE /time-off/{uuid}","href":"/api/availability/delete-time-off-period"},{"title":"List Holiday Categories","openapi":"GET /holidays/categories","href":"/api/holidays/list-holiday-categories"},{"title":"Preview Holidays for a Category","openapi":"GET /holidays/preview","href":"/api/holidays/preview-holidays"},{"title":"List Holiday Subscriptions","openapi":"GET /holidays/subscriptions","href":"/api/holidays/list-holiday-subscriptions"},{"title":"Create Holiday Subscriptions","openapi":"POST /holidays/subscriptions","href":"/api/holidays/create-holiday-subscriptions"},{"title":"Delete a Holiday Subscription","openapi":"DELETE /holidays/subscriptions/{id}","href":"/api/holidays/delete-holiday-subscription"},{"title":"Toggle Holiday Overrides","description":"Override individual holidays within a subscription — opt back in to specific dates without unsubscribing from the entire category.","openapi":"PUT /holidays/subscriptions/{id}/overrides","href":"/api/holidays/toggle-holiday-overrides"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Create Webhook Subscription","openapi":"POST /webhooks","href":"/api/webhooks/create-webhook-subscription"},{"title":"List Webhook Subscriptions","description":"List all webhook subscriptions for a given scope (user, team, or organization), including their callback URLs and event types.","openapi":"GET /webhooks/scope/{scope}","href":"/api/webhooks/list-webhook-subscriptions"},{"title":"Get Webhook Subscription","openapi":"GET /webhooks/{uuid}","href":"/api/webhooks/get-webhook-subscription"},{"title":"Delete Webhook Subscription","openapi":"DELETE /webhooks/{uuid}","href":"/api/webhooks/delete-webhook-subscription"}]},{"group":"Notes","expanded":false,"pages":[{"title":"Create a Note","openapi":"POST /notes","href":"/api/notes/create-a-note"},{"title":"List Notes by Event","openapi":"GET /notes/event/{uuid}","href":"/api/notes/list-notes-by-event"},{"title":"Get a Note","openapi":"GET /notes/{id}","href":"/api/notes/get-a-note"},{"title":"Update a Note","openapi":"PUT /notes/{id}","href":"/api/notes/update-a-note"},{"title":"Delete a Note","openapi":"DELETE /notes/{id}","href":"/api/notes/delete-a-note"}]},{"group":"Workspaces \u0026 Teams","expanded":false,"pages":[{"title":"Check Logged-in User","openapi":"GET /whoami","href":"/api/workspaces-teams/check-logged-in-user"},{"title":"List Users in a Workspace","openapi":"GET /organizations/users","href":"/api/workspaces-teams/list-users-in-a-workspace"},{"title":"List Teams","openapi":"GET /teams","href":"/api/workspaces-teams/list-teams"},{"title":"Create a Team","openapi":"POST /teams","href":"/api/workspaces-teams/create-a-team"},{"title":"Update a Team","openapi":"PATCH /teams/{teamId}","href":"/api/workspaces-teams/update-a-team"},{"title":"Delete a Team","openapi":"DELETE /teams/{teamId}","href":"/api/workspaces-teams/delete-a-team"},{"title":"List Team Members","openapi":"GET /teams/{teamId}/members","href":"/api/workspaces-teams/list-team-members"},{"title":"Add a Team Member","openapi":"POST /teams/{teamId}/members","href":"/api/workspaces-teams/add-a-team-member"},{"title":"Remove a Team Member","openapi":"DELETE /teams/{teamId}/members/{memberId}","href":"/api/workspaces-teams/remove-a-team-member"},{"title":"Invite People to the Workspace","openapi":"POST /organizations/invitations","href":"/api/workspaces-teams/invite-people"},{"title":"List Pending Invitations","openapi":"GET /organizations/invitations","href":"/api/workspaces-teams/list-invitations"},{"title":"Revoke an Invitation","openapi":"DELETE /organizations/invitations/{invitationId}","href":"/api/workspaces-teams/revoke-an-invitation"}]},{"group":"AI Agent","expanded":false,"pages":[{"title":"Create Outbound Call","openapi":"POST /agents/{agentUuid}/outbound-calls","href":"/api/ai-agent/create-outbound-call"},{"title":"List AI Agents","openapi":"GET /agents","href":"/api/ai-agent/list-agents"},{"title":"List Agent Calls","openapi":"GET /agents/{agentUuid}/calls","href":"/api/ai-agent/list-agent-calls"},{"title":"Get Agent Call","openapi":"GET /agent-calls/{callId}","href":"/api/ai-agent/get-agent-call"}]},{"group":"Webhook Payloads","expanded":false,"pages":[{"title":"Event Webhook Payload","href":"/api/webhook-payloads/event-webhook-payload"},{"title":"Routing Form Webhook Payload","href":"/api/webhook-payloads/routing-form-webhook-payload"},{"title":"AI Agent Call Webhook Payload","href":"/api/webhook-payloads/ai-agent-call-webhook-payload"}]},{"group":"CRM","expanded":false,"pages":[{"title":"CRM Overview","href":"/api/crm/overview"},{"group":"Objects","pages":[{"title":"List CRM Objects","openapi":"GET /crm/objects","href":"/api/crm/list-crm-objects"},{"title":"Get a CRM Object","openapi":"GET /crm/objects/{slug}","href":"/api/crm/get-a-crm-object"},{"title":"Create a CRM Object","openapi":"POST /crm/objects","href":"/api/crm/create-a-crm-object"},{"title":"Update a CRM Object","openapi":"PATCH /crm/objects/{slug}","href":"/api/crm/update-a-crm-object"},{"title":"Delete a CRM Object","openapi":"DELETE /crm/objects/{slug}","href":"/api/crm/delete-a-crm-object"},{"title":"Add Attribute to CRM Object","openapi":"POST /crm/objects/{slug}/attributes","href":"/api/crm/add-attribute-to-crm-object"},{"title":"Update CRM Object Attribute","openapi":"PATCH /crm/objects/{slug}/attributes/{attributeKey}","href":"/api/crm/update-crm-object-attribute"}]},{"group":"Companies","pages":[{"title":"List CRM Companies","openapi":"GET /crm/companies","href":"/api/crm/list-crm-companies"},{"title":"Get a CRM Company","openapi":"GET /crm/companies/{id}","href":"/api/crm/get-a-crm-company"},{"title":"Create a CRM Company","openapi":"POST /crm/companies","href":"/api/crm/create-a-crm-company"},{"title":"Assert a CRM Company","openapi":"PUT /crm/companies","href":"/api/crm/assert-a-crm-company"},{"title":"Patch a CRM Company","openapi":"PATCH /crm/companies/{id}","href":"/api/crm/patch-a-crm-company"},{"title":"Delete a CRM Company","openapi":"DELETE /crm/companies/{id}","href":"/api/crm/delete-a-crm-company"}]},{"group":"People","pages":[{"title":"List CRM People","openapi":"GET /crm/people","href":"/api/crm/list-crm-people"},{"title":"Get a CRM Person","openapi":"GET /crm/people/{id}","href":"/api/crm/get-a-crm-person"},{"title":"Create a CRM Person","openapi":"POST /crm/people","href":"/api/crm/create-a-crm-person"},{"title":"Assert a CRM Person","openapi":"PUT /crm/people","href":"/api/crm/update-a-crm-person"},{"title":"Patch a CRM Person","openapi":"PATCH /crm/people/{id}","href":"/api/crm/patch-a-crm-person"},{"title":"Delete a CRM Person","openapi":"DELETE /crm/people/{id}","href":"/api/crm/delete-a-crm-person"}]},{"group":"Records","pages":[{"title":"List CRM Records","openapi":"GET /crm/{objectSlug}","href":"/api/crm/list-crm-records"},{"title":"Get a CRM Record","openapi":"GET /crm/{objectSlug}/{recordId}","href":"/api/crm/get-a-crm-record"},{"title":"Create a CRM Record","openapi":"POST /crm/{objectSlug}","href":"/api/crm/create-a-crm-record"},{"title":"Assert a CRM Record (Upsert)","openapi":"PUT /crm/{objectSlug}","href":"/api/crm/assert-a-crm-record"},{"title":"Patch a CRM Record","openapi":"PATCH /crm/{objectSlug}/{recordId}","href":"/api/crm/patch-a-crm-record"},{"title":"Delete a CRM Record","openapi":"DELETE /crm/{objectSlug}/{recordId}","href":"/api/crm/delete-a-crm-record"},{"title":"Update a CRM Record Relation","openapi":"PATCH /crm/{objectSlug}/{recordId}/relation","href":"/api/crm/update-relation-crm-record"}]}]},{"group":"Routing Forms","expanded":false,"pages":[{"title":"Routing Forms Overview","href":"/api/routing-forms/overview"},{"group":"Forms","pages":[{"title":"List Routing Forms","openapi":"GET /routing-forms","href":"/api/routing-forms/list-routing-forms"},{"title":"Get a Routing Form","openapi":"GET /routing-forms/{id}","href":"/api/routing-forms/get-a-routing-form"},{"title":"Create a Routing Form","openapi":"POST /routing-forms","href":"/api/routing-forms/create-a-routing-form"},{"title":"Update a Routing Form","openapi":"PATCH /routing-forms/{id}","href":"/api/routing-forms/update-a-routing-form"},{"title":"Duplicate a Routing Form","openapi":"POST /routing-forms/{id}/duplicate","href":"/api/routing-forms/duplicate-a-routing-form"},{"title":"Replace Routing Form Questions","openapi":"PUT /routing-forms/{id}/inputs","href":"/api/routing-forms/replace-routing-form-questions"},{"title":"Replace Routing Form Routes","openapi":"PUT /routing-forms/{id}/routes","href":"/api/routing-forms/replace-routing-form-routes"},{"title":"Delete a Routing Form","openapi":"DELETE /routing-forms/{id}","href":"/api/routing-forms/delete-a-routing-form"}]},{"group":"Submissions","pages":[{"title":"List Routing Form Submissions","openapi":"GET /routing-form-submissions","href":"/api/routing-forms/list-routing-form-submissions"},{"title":"Get a Routing Form Submission","openapi":"GET /routing-form-submissions/{id}","href":"/api/routing-forms/get-a-routing-form-submission"},{"title":"Delete a Routing Form Submission","openapi":"DELETE /routing-form-submissions/{id}","href":"/api/routing-forms/delete-a-routing-form-submission"}]}]}]}]}]},"basePath":"","title":"Create Webhook Subscription - Zeeg Developer Hub","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-_HcdDqS2.js","snippetPresets-CXnm-WO6.js","utils-Dg59J__o.js","style-to-object-BY3JEAdk.js","utils-D8TRpdk7.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-B6QaxWc5.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DeMZ-lcM.js","_Uint8Array-BjA2mcVW.js","isObject-FP1Yky1u.js","Page-DuqezyvM.js","CodeSnippet-B373COAT.js","DynamicMarkdown-5yMTCLas.js","SectionHeading-BxT1HYfP.js","icon-DYJTTD3g.js","ApiExamples-cjPyMv63.js","usePlaygroundInputsStore-D7BWoaw4.js","shallow-Z1ceDNSG.js","isEqual-BObTuQrO.js","CodeSnippets-D1UZ1AE-.js","getApiPlaygroundDisplay-CfL-UuDS.js","MethodPill-4AyycJeu.js","getPastedJson-Bp3WV6cN.js","Check2Icon-PhZu6Gry.js","axios-CsQoIw0U.js","Markdown-Dy9a8hT8.js","AssistantPageLink-87tSPwGm.js","dist-CXMB3QQU.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}