Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery.
Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}. API keys are issued and revoked directly from the creditor portal under Developers > API.
Hold deliveries for polling through GET /v1/{tenantId}/webhooks/items instead of POSTing them. After processing each item, acknowledge it with PATCH /v1/{tenantId}/webhooks/items/{itemId} and state=SUCCESS.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Debbie Creditor API Documentation","colors":{"primary":"#7568F6","light":"#07C983","dark":"#7865FF"},"logo":{"light":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/light.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=10910a8dfb5076aec86b09686383b541","dark":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/dark.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=a44edc79d1f69627d88b16d9a5157fb9"},"favicon":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/favicon.png?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=b296397199b185d9fb11859d70d6c74c","navbar":{"links":[{"href":"mailto:api-support@debbie.dk","label":"API Support"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/debbie"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Status","icon":"chart-network","href":"https://debbie.checkly-status-page.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"debbie-creditor-documentation","hasAudioNarration":false,"actualSubdomain":"debbie-creditor-documentation","customDomains":["creditor-documentation.debbiecollect.com"],"gitSource":{"type":"github","owner":"debbie-platform","repo":"debbie","deployBranch":"master","contentDirectory":"documentation/public-creditor-api","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af07e5a19e45f289c56f508","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Webhooks","count":11},{"language":"default","tag":"Using the API","count":6},{"language":"default","tag":"API Documentation","count":5},{"language":"default","tag":"Customers","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Billings","count":2},{"language":"default","tag":"Files","count":2},{"language":"default","tag":"Case voucher allocations","count":1}]},"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":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/webhooks/create","slug":"/api-reference/endpoints/webhooks/create","pageMetadata":{"title":"Create webhook","openapi":"POST /v1/{tenantId}/webhooks","description":"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery.\n\n**Required scope:** `write:webhooks`","href":"/api-reference/endpoints/webhooks/create"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Required scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"write:webhooks\"\n })]\n })]\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","openapi":"POST /v1/{tenantId}/webhooks","description":"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery.\n\n**Required scope:** `write:webhooks`","href":"/api-reference/endpoints/webhooks/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Webhooks"],"summary":"Create webhook","description":"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery.\n\n**Required scope:** `write:webhooks`","operationId":"create-webhook","parameters":["2e417ad8-3130-4441-bee9-2dc96b3a024e","5f69b705-982a-4538-bee6-11d5c1cec1fa"],"requestBody":"5e671338-a355-47e7-87f0-4fc2cbd7f5c2","responses":{"200":"548837bd-552d-4182-8dfa-98c534dc4878","401":"262adc0c-f6f7-4bdd-977c-0f379c8bb59f","422":"b7a8da25-ea2b-474c-91f7-229be7de87a0"},"method":"post","type":"path","servers":["cc6f2f36-b7d4-4509-a86c-ea66de6298f4"],"security":["af845bea-a179-4d12-a982-b17bced29b4d"],"path":"/v1/{tenantId}/webhooks","baseUrlOptions":["https://api.debbiecollect.com"],"title":"Create webhook","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2e417ad8-3130-4441-bee9-2dc96b3a024e":{"in":"path","name":"tenantId","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Id of the tenant","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Id of the tenant"},"5f69b705-982a-4538-bee6-11d5c1cec1fa":{"in":"query","name":"creditorId","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Your creditor id. You can find it on the API page in the creditor portal.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Your creditor id. You can find it on the API page in the creditor portal."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the webhook. Shown in the portal and on every delivery.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"url":{"type":"string","format":"uri","description":"Public HTTP(S) address every delivery is POSTed to unless pull=true. Required even for pull webhooks. Addresses on a private network are rejected.","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"events":{"type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Events to subscribe to. A creditor webhook can subscribe to cases.create, cases.update, cases.delete and billings.create.","isRequired":true,"uniqueKey":"events","typeLabel":"string[]"},"creditorId":{"type":"string","format":"uuid","description":"Id of the creditor the webhook is scoped to. Must be the creditor the key is issued for.","isRequired":true,"uniqueKey":"creditorId","typeLabel":"string\u003cuuid>"},"email":{"oneOf":[{"type":"string","format":"email","description":"Address notified when deliveries keep failing.","uniqueKey":"email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Address notified when deliveries keep failing.","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string\u003cemail> | null"},"headers":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"headers.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Extra headers sent with every delivery, for example an authorization header the receiver expects.","uniqueKey":"headers.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"headers.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Extra headers sent with every delivery, for example an authorization header the receiver expects.","uniqueKey":"headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"headers","typeLabel":"object | null"},"deepFlattenBody":{"type":"boolean","description":"Flatten nested objects in the body into single level keys joined by \"_\", for receivers that cannot read nested JSON. Defaults to false.","uniqueKey":"deepFlattenBody","typeLabel":"boolean"},"pull":{"type":"boolean","default":false,"description":"Hold deliveries for polling through GET /v1/{tenantId}/webhooks/items instead of POSTing them. After processing each item, acknowledge it with PATCH /v1/{tenantId}/webhooks/items/{itemId} and state=SUCCESS.","uniqueKey":"pull","typeLabel":"boolean"}},"required":["name","url","events","creditorId"],"uniqueKey":"","typeLabel":"object"},"example":{"name":"ERP sync","url":"https://example.com/debbie/webhooks","events":["cases.create","cases.update"],"email":"integrations@example.com","creditorId":"0f6c7a3e-6e4e-4f0c-9a2a-2f6cba3f9a11"},"examples":{"Example":{"title":"Example","value":{"name":"ERP sync","url":"https://example.com/debbie/webhooks","events":["cases.create","cases.update"],"email":"integrations@example.com","creditorId":"0f6c7a3e-6e4e-4f0c-9a2a-2f6cba3f9a11"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"548837bd-552d-4182-8dfa-98c534dc4878":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of the webhook","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name of the webhook","uniqueKey":"name","typeLabel":"string"},"url":{"type":"string","format":"uri","description":"Address every delivery is POSTed to","uniqueKey":"url","typeLabel":"string\u003curi>"},"events":{"type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX]","typeLabel":"string"},"description":"Events the webhook is subscribed to","uniqueKey":"events","typeLabel":"string[]"},"creditorId":{"type":"string","format":"uuid","description":"Id of the creditor the webhook is scoped to. A creditor webhook only receives events for this creditor.","uniqueKey":"creditorId","typeLabel":"string\u003cuuid>"},"verificationToken":{"type":"string","format":"uuid","description":"Sent as the X-Verification-Token header on every delivery. Compare it with this value and reject requests that do not match.","uniqueKey":"verificationToken","typeLabel":"string\u003cuuid>"},"email":{"oneOf":[{"type":"string","format":"email","description":"Address notified when deliveries keep failing. null when no address was given.","uniqueKey":"email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Address notified when deliveries keep failing. null when no address was given.","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string\u003cemail> | null"},"headers":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"headers.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Extra headers sent with every delivery","uniqueKey":"headers.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"headers.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Extra headers sent with every delivery","uniqueKey":"headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"headers","typeLabel":"object | null"},"bodyMappers":{"oneOf":[{"type":"object","description":"Per event field maps that reshape the body before it is sent. null when the body is sent as it is.","uniqueKey":"bodyMappers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Per event field maps that reshape the body before it is sent. null when the body is sent as it is.","uniqueKey":"bodyMappers.oneOf.1","typeLabel":"null"}],"uniqueKey":"bodyMappers","typeLabel":"object | null"},"deepFlattenBody":{"type":"boolean","description":"Whether nested objects in the body are flattened into single level keys joined by \"_\"","uniqueKey":"deepFlattenBody","typeLabel":"boolean"},"pull":{"type":"boolean","description":"Whether deliveries wait to be pulled through the webhook items endpoints instead of being POSTed","uniqueKey":"pull","typeLabel":"boolean"},"enabled":{"type":"boolean","description":"Whether the webhook is receiving events","uniqueKey":"enabled","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","description":"When the webhook was created","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"createdBy":{"oneOf":[{"type":"object","description":"Who created the webhook","properties":{"id":{"type":"string","description":"Id of the actor","uniqueKey":"createdBy.oneOf.0.id","typeLabel":"string"},"type":{"type":"string","description":"Type of the actor","uniqueKey":"createdBy.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"createdBy.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who created the webhook","properties":{"id":{"type":"string","description":"Id of the actor"},"type":{"type":"string","description":"Type of the actor"}},"uniqueKey":"createdBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdBy","typeLabel":"object | null"}},"example":{"id":"b963f219-255e-47b7-a3f2-0fe6180514a1","name":"ERP sync","url":"https://example.com/debbie/webhooks","events":["cases.create","cases.update"],"creditorId":"0f6c7a3e-6e4e-4f0c-9a2a-2f6cba3f9a11","verificationToken":"5f2e6a55-6f7d-4d0e-8f1c-2f5a2f8d7c11","email":"integrations@example.com","headers":{"X-Custom":"value"},"deepFlattenBody":false,"pull":false,"enabled":true,"createdAt":"2026-08-29T11:21:10.100Z","createdBy":{"id":"b1a2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","type":"KEY"},"bodyMappers":null},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"b963f219-255e-47b7-a3f2-0fe6180514a1","name":"ERP sync","url":"https://example.com/debbie/webhooks","events":["cases.create","cases.update"],"creditorId":"0f6c7a3e-6e4e-4f0c-9a2a-2f6cba3f9a11","verificationToken":"5f2e6a55-6f7d-4d0e-8f1c-2f5a2f8d7c11","email":"integrations@example.com","headers":{"X-Custom":"value"},"deepFlattenBody":false,"pull":false,"enabled":true,"createdAt":"2026-08-29T11:21:10.100Z","createdBy":{"id":"b1a2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","type":"KEY"},"bodyMappers":null}}},"exampleType":"generated"}},"exampleType":"generated"},"262adc0c-f6f7-4bdd-977c-0f379c8bb59f":{"description":"Access token missing or invalid","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b7a8da25-ea2b-474c-91f7-229be7de87a0":{"description":"Unable to process the contained instructions.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"af845bea-a179-4d12-a982-b17bced29b4d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"cc6f2f36-b7d4-4509-a86c-ea66de6298f4":{"url":"https://api.debbiecollect.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"debbie-creditor-documentation","siteName":"Debbie Creditor API Documentation","title":"Create webhook - Debbie Creditor API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T10:51:11.205Z","originalFileLocation":"api-reference/endpoints/webhooks/create.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=\"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery. Required scope: write:webhooks\">\u003cmeta data-mint-head name=\"application-name\" content=\"Debbie Creditor API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create webhook - Debbie Creditor API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery. Required scope: write:webhooks\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Debbie Creditor API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://debbie-creditor-documentation.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+webhook\u0026amp;description=Creates+a+webhook+for+the+events+it+is+subscribed+to.+By+default%2C+deliveries+are+POSTed+to+the+URL.+Set+pull%3Dtrue+to+hold+deliveries+for+polling+through+the+web\u0026amp;theme=6e81307c9eeccd10d2f7bdff\u0026amp;signature=274cf9f89263427192d02530c344e43246cb944fc532e4d773582b55fc946a75\">\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 - Debbie Creditor API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery. Required scope: write:webhooks\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://debbie-creditor-documentation.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+webhook\u0026amp;description=Creates+a+webhook+for+the+events+it+is+subscribed+to.+By+default%2C+deliveries+are+POSTed+to+the+URL.+Set+pull%3Dtrue+to+hold+deliveries+for+polling+through+the+web\u0026amp;theme=6e81307c9eeccd10d2f7bdff\u0026amp;signature=274cf9f89263427192d02530c344e43246cb944fc532e4d773582b55fc946a75\">\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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Debbie Creditor API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7568F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/webhooks/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\",\"name\":\"Debbie Creditor API Documentation\",\"url\":\"https://creditor-documentation.debbiecollect.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/light.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=10910a8dfb5076aec86b09686383b541\"}},{\"@type\":\"WebSite\",\"@id\":\"https://creditor-documentation.debbiecollect.com#website\",\"name\":\"Debbie Creditor API Documentation\",\"url\":\"https://creditor-documentation.debbiecollect.com\",\"publisher\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create#webpage\",\"url\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create\",\"name\":\"Create webhook\",\"description\":\"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery. Required scope: write:webhooks\",\"dateModified\":\"2026-09-23T10:51:11.205Z\",\"isPartOf\":{\"@id\":\"https://creditor-documentation.debbiecollect.com#website\"},\"breadcrumb\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://creditor-documentation.debbiecollect.com/api-reference/webhooks/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create webhook\",\"item\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create#apireference\",\"headline\":\"Create webhook\",\"name\":\"Create webhook\",\"description\":\"Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery. Required scope: write:webhooks\",\"url\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create\",\"mainEntityOfPage\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create#webpage\"},\"dateModified\":\"2026-09-23T10:51:11.205Z\",\"publisher\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\"},\"isPartOf\":{\"@id\":\"https://creditor-documentation.debbiecollect.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Debbie Creditor API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Debbie Creditor API Documentation","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"chart-network","href":"https://debbie.checkly-status-page.com"}]},"tabs":[{"tab":"Using the API","pages":[{"title":"Using the API","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Voucher types","href":"/api-reference/voucher-types"}]},{"group":"Customers","pages":[{"title":"Create customer","openapi":"POST /v1/{tenantId}/customers","href":"/api-reference/endpoints/customers/create"},{"title":"Get customer by id","openapi":"GET /v1/{tenantId}/customers/{customerId}","href":"/api-reference/endpoints/customers/get"},{"title":"Get customer by reference id","openapi":"GET /v1/{tenantId}/customers/by-reference-id/{referenceId}","href":"/api-reference/endpoints/customers/get-by-reference"},{"title":"Add case vouchers","openapi":"POST /v1/{tenantId}/customers/{customerId}/add-case-vouchers","href":"/api-reference/endpoints/customers/add-case-vouchers"}]},{"group":"Case voucher allocations","pages":[{"title":"Register case voucher allocation","openapi":"POST /v1/{tenantId}/case-vouchers/allocations","href":"/api-reference/endpoints/case-vouchers/allocations"}]},{"group":"Files","pages":[{"title":"Upload file","openapi":"POST /v1/{tenantId}/files","href":"/api-reference/endpoints/files/create"},{"title":"Get file","openapi":"GET /v1/{tenantId}/files/{fileId}/{fileName}","href":"/api-reference/endpoints/files/get"}]},{"group":"Documents","pages":[{"title":"Add document","openapi":"POST /v1/{tenantId}/documents","href":"/api-reference/endpoints/documents/create"}]},{"group":"Voucher types","pages":[{"title":"Get voucher types","openapi":"GET /v1/{tenantId}/voucher-types","href":"/api-reference/endpoints/voucher-types/get"}]},{"group":"Billings","pages":[{"title":"Get deposit distribution","openapi":"GET /v1/{tenantId}/billings/{billingId}/deposit-distribution","href":"/api-reference/endpoints/billings/deposit-distribution"},{"title":"Get billing vouchers","openapi":"GET /v1/{tenantId}/billings/{billingId}/billing-vouchers","href":"/api-reference/endpoints/billings/billing-vouchers"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","description":"Receive events through webhook deliveries or poll pending items","href":"/api-reference/webhooks/introduction"},{"title":"Create webhook","openapi":"POST /v1/{tenantId}/webhooks","href":"/api-reference/endpoints/webhooks/create"},{"title":"Get webhooks","openapi":"GET /v1/{tenantId}/webhooks","description":"Lists the webhooks that are receiving events, paginated. Stop paging when a page comes back with fewer items than pageSize. A key only ever sees the webhooks of the creditor it is issued for.\n\n**Required scope:** `read:webhooks`","href":"/api-reference/endpoints/webhooks/get-list"},{"title":"Get webhook","openapi":"GET /v1/{tenantId}/webhooks/{webhookId}","href":"/api-reference/endpoints/webhooks/get"},{"title":"Delete webhook","openapi":"DELETE /v1/{tenantId}/webhooks/{webhookId}","href":"/api-reference/endpoints/webhooks/delete"},{"title":"Get webhook items","openapi":"GET /v1/{tenantId}/webhooks/items","href":"/api-reference/endpoints/webhooks/get-items"},{"title":"Patch webhook item","openapi":"PATCH /v1/{tenantId}/webhooks/items/{itemId}","href":"/api-reference/endpoints/webhooks/patch-item"},{"title":"Case created","openapi":"webhook cases.create","href":"/api-reference/webhooks/cases.create"},{"title":"Case updated","openapi":"webhook cases.update","href":"/api-reference/webhooks/cases.update"},{"title":"Case deleted","openapi":"webhook cases.delete","href":"/api-reference/webhooks/cases.delete"},{"title":"Billing created","openapi":"webhook billings.create","href":"/api-reference/webhooks/billings.create"}]}]}]},"basePath":"","title":"Create webhook - Debbie Creditor API Documentation","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"]}