A randomly generated 32-byte key, encoded in Base64, used to encrypt messages. This key is necessary for encryption but is not retrievable after being set.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Teal","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/teal/Bcr09DVpVxdrVRJl/logo/light.svg?fit=max\u0026auto=format\u0026n=Bcr09DVpVxdrVRJl\u0026q=85\u0026s=f1f94f62054040d698706983d3b88016","dark":"https://mintcdn.com/teal/Bcr09DVpVxdrVRJl/logo/dark.svg?fit=max\u0026auto=format\u0026n=Bcr09DVpVxdrVRJl\u0026q=85\u0026s=e6414f548a8e27e0c07175a488d2f256"},"favicon":"https://mintcdn.com/teal/Bcr09DVpVxdrVRJl/favicon.svg?fit=max\u0026auto=format\u0026n=Bcr09DVpVxdrVRJl\u0026q=85\u0026s=dfb4da63f6b3fdca92c71519210b7ccd","navbar":{"links":[{"href":"mailto:hello@goteal.co","label":"Support"}]},"footer":{"socials":{"website":"https://goteal.co","linkedin":"https://www.linkedin.com/company/goteal"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"book-open-cover","href":"https://goteal.co"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"teal","hasAudioNarration":false,"actualSubdomain":"teal","customDomains":["docs.goteal.co"],"gitSource":{"type":"github","owner":"teal-connect","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb82c56e43bdfe55f01a95","collectionId":"a44b63e9-4fff-4cf7-86d1-961ae27c6af7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb82c56e43bdfe55f01a95"},"entitlements":{},"buildId":"6adb82c56e43bdfe55f01a95","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":45},{"language":"default","tag":"Accounts","count":7},{"language":"default","tag":"Authorisations","count":7},{"language":"default","tag":"Doc Scan","count":6},{"language":"default","tag":"Payroll","count":6},{"language":"default","tag":"Users","count":6},{"language":"default","tag":"Documentation","count":5},{"language":"default","tag":"Get Started","count":5},{"language":"default","tag":"Webhooks","count":4},{"language":"default","tag":"Configuration","count":2}]},"assistantConfig":{},"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":"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/webhooks/create","slug":"/api-reference/webhooks/create","pageMetadata":{"title":"Create a Webhook","openapi":"POST /webhooks","description":null,"href":"/api-reference/webhooks/create"},"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 a Webhook","openapi":"POST /webhooks","description":null,"href":"/api-reference/webhooks/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Creates a webhook.","requestBody":"ed195748-bb6c-444d-8cce-9b3f329e84a9","responses":{"201":"f67199b0-4a39-4351-850f-8ce9b0de6721","400":"741899bc-9e9f-4634-a54a-4f853c9dd024","401":"ae96b687-fb79-4cc0-9a01-069b6b783263"},"method":"post","type":"path","servers":["742833a9-e448-4843-b38b-cd5bf228a9b1","77e4d818-25f3-46e0-88a5-6a8a8c77be0b"],"security":["8743a874-0cd2-4d0c-8a8e-3e3b9575bc00","0f4075f2-9d33-4ac3-bf9b-204c486e24cb"],"path":"/webhooks","baseUrlOptions":["https://api.sandbox.goteal.co","https://api.goteal.co"],"title":"Creates a webhook.","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","events","url"],"properties":{"name":{"type":"string","description":"A unique name of the webhook","example":"user-payroll-submitted","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"events":{"type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX]","typeLabel":"string"},"example":["user-payroll-submitted","user-hmrc-data-submitted","user-bank-statement-submitted"],"isRequired":true,"uniqueKey":"events","typeLabel":"string[]"},"url":{"type":"string","format":"url","example":"https://webhooks.company.com","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curl>"},"signing_secret":{"type":"string","description":"A secret to sign the body of the webhook as described at \"https://docs.goteal.co\"","writeOnly":true,"example":"very-secret","uniqueKey":"signing_secret","typeLabel":"string"},"encryption_key":{"type":"string","description":"A randomly generated 32-byte key, encoded in Base64, used to encrypt messages. This key is necessary for encryption but is not retrievable after being set.","writeOnly":true,"example":"St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=","uniqueKey":"encryption_key","typeLabel":"string"},"config":{"type":"object","description":"Configuration properties of the webhook","writeOnly":true,"properties":{"include_payload":{"type":"boolean","description":"Whether to include or not the payload of the event in the webhook","example":true,"uniqueKey":"config.include_payload","typeLabel":"boolean"}},"uniqueKey":"config","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"user-payroll-submitted","events":["user-payroll-submitted","user-hmrc-data-submitted","user-bank-statement-submitted"],"url":"https://webhooks.company.com","signing_secret":"very-secret","encryption_key":"St/73LZ1xHkwX5TanL7V+YAVczn4acozPf3cFySKQXI=","config":{"include_payload":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f67199b0-4a39-4351-850f-8ce9b0de6721":{"description":"Created","content":{"application/json":{"schema":{"type":"object","required":["created_at","name","events","url","webhook_id"],"properties":{"webhook_id":{"type":"string","description":"The id of the webhook","example":"95a0e70b-fe02-4f47-aef9-2efff279df71","isRequired":true,"uniqueKey":"webhook_id","typeLabel":"string"},"name":{"type":"string","description":"A unique name of the webhook","example":"user-payroll-submitted","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"events":{"type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX]","typeLabel":"string"},"example":["user-payroll-submitted","user-hmrc-data-submitted","user-bank-statement-submitted"],"isRequired":true,"uniqueKey":"events","typeLabel":"string[]"},"url":{"type":"string","format":"url","example":"https://webhooks.company.com","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curl>"},"created_at":{"type":"string","format":"date-time","example":"2019-05-17T00:00:00.000Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"webhook_id":"95a0e70b-fe02-4f47-aef9-2efff279df71","name":"user-payroll-submitted","events":["user-payroll-submitted","user-hmrc-data-submitted","user-bank-statement-submitted"],"url":"https://webhooks.company.com","created_at":"2019-05-17T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"741899bc-9e9f-4634-a54a-4f853c9dd024":{"description":"Bad request if one of the required parameters is missing","content":{"application/json":{"schema":{"required":["errors"],"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"description":"An array of messages describing the errors","example":["The request is missing the required field `name`"],"isRequired":true,"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":["The request is missing the required field `name`"]}}},"exampleType":"generated"}},"exampleType":"generated"},"ae96b687-fb79-4cc0-9a01-069b6b783263":{"description":"Unauthorized if the X-API-KEY is not provided or is wrong","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string","description":"An array of messages describing the errors","example":["No X-API-KEY header provided or wrong value"],"uniqueKey":"errors","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":["No X-API-KEY header provided or wrong value"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8743a874-0cd2-4d0c-8a8e-3e3b9575bc00":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[],"schemeName":"ApiKeyAuth"}},"0f4075f2-9d33-4ac3-bf9b-204c486e24cb":{"MemberBearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token for authentication. The token should be the one returned by the \"/members/signin\"","scopes":[],"schemeName":"MemberBearerAuth"}}},"servers":{"742833a9-e448-4843-b38b-cd5bf228a9b1":{"url":"https://api.sandbox.goteal.co","description":"Sandbox server for experiments"},"77e4d818-25f3-46e0-88a5-6a8a8c77be0b":{"url":"https://api.goteal.co","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-KEY"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token for authentication. The token should be the one returned by the \"/members/signin\"","scopes":[],"schemeName":"MemberBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token for authentication. The token should be the one returned by the \"/members/signin\"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"MemberBearerAuth","name":"Authorization"}],"title":"MemberBearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"teal","siteName":"Teal","title":"Create a Webhook - Teal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T15:52:42.997Z","originalFileLocation":"api-reference/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=\"application-name\" content=\"Teal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a Webhook - Teal\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Teal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.goteal.co/api-reference/webhooks/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://teal.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+a+Webhook\u0026amp;theme=20e9f009a1ad75d8032a04e4\u0026amp;signature=17ad5c0588725438eb10a88f86665f60276400d6b96e6de9e492141c409a2cd2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a Webhook - Teal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://teal.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+a+Webhook\u0026amp;theme=20e9f009a1ad75d8032a04e4\u0026amp;signature=17ad5c0588725438eb10a88f86665f60276400d6b96e6de9e492141c409a2cd2\">\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/teal/LMHi1fxtC26ppOnK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Teal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.goteal.co/api-reference/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/webhooks/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.goteal.co/#organization\",\"name\":\"Teal\",\"url\":\"https://docs.goteal.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/teal/Bcr09DVpVxdrVRJl/logo/light.svg?fit=max\u0026auto=format\u0026n=Bcr09DVpVxdrVRJl\u0026q=85\u0026s=f1f94f62054040d698706983d3b88016\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.goteal.co#website\",\"name\":\"Teal\",\"url\":\"https://docs.goteal.co\",\"publisher\":{\"@id\":\"https://docs.goteal.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.goteal.co/api-reference/webhooks/create#webpage\",\"url\":\"https://docs.goteal.co/api-reference/webhooks/create\",\"name\":\"Create a Webhook\",\"dateModified\":\"2026-10-23T15:52:42.997Z\",\"isPartOf\":{\"@id\":\"https://docs.goteal.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.goteal.co/api-reference/webhooks/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.goteal.co/api-reference/webhooks/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Teal\",\"item\":\"https://docs.goteal.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a Webhook\",\"item\":\"https://docs.goteal.co/api-reference/webhooks/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.goteal.co/api-reference/webhooks/create#apireference\",\"headline\":\"Create a Webhook\",\"name\":\"Create a Webhook\",\"url\":\"https://docs.goteal.co/api-reference/webhooks/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.goteal.co/api-reference/webhooks/create#webpage\"},\"dateModified\":\"2026-10-23T15:52:42.997Z\",\"publisher\":{\"@id\":\"https://docs.goteal.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.goteal.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Teal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Teal","nav":{"global":{"anchors":[{"anchor":"Website","icon":"book-open-cover","href":"https://goteal.co"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Quickstart","href":"/api-reference/quickstart"},{"title":"Webhooks","href":"/api-reference/webhooks"}]},{"group":"Users","pages":[{"title":"Create a User","openapi":"POST /users","href":"/api-reference/users/create"},{"title":"Retrieve a user","openapi":"GET /users/{user_id}","href":"/api-reference/users/get"},{"title":"Update a User","openapi":"PATCH /users/{user_id}","href":"/api-reference/users/update"},{"title":"List all users","openapi":"GET /users","href":"/api-reference/users/list"},{"title":"List all recurring users","openapi":"GET /users/recurring","href":"/api-reference/users/list-recurring"},{"title":"Delete a user","openapi":"DELETE /users/{user_id}","href":"/api-reference/users/delete"}]},{"group":"User Token","pages":[{"title":"Generate User token","openapi":"POST /user-tokens","href":"/api-reference/users/tokens"}]},{"group":"Accounts","pages":[{"title":"Create an account","openapi":"POST /accounts","href":"/api-reference/accounts/create"},{"title":"Submit MFA response","openapi":"PUT /accounts/{account_id}/mfa","href":"/api-reference/accounts/mfa"},{"title":"Direct Connection","openapi":"POST /accounts/direct-connections","href":"/api-reference/accounts/direct-connections-create"},{"title":"List all accounts","openapi":"GET /accounts","href":"/api-reference/accounts/list"},{"title":"List all recurring accounts","openapi":"GET /accounts/recurring","href":"/api-reference/accounts/list-recurring"},{"title":"Get an account","openapi":"GET /accounts/{account_id}","href":"/api-reference/accounts/get"},{"title":"Delete an account","openapi":"DELETE /accounts/{account_id}","href":"/api-reference/accounts/delete"}]},{"group":"Payroll","pages":[{"title":"Query Payroll Connection","openapi":"POST /payroll/entries/connections","href":"/api-reference/payroll/connections-create"},{"title":"Generate presigned payslip URLs","openapi":"POST /payroll/entries/payslips/presign","href":"/api-reference/payroll/payslips-presign"},{"title":"Payslips upload","openapi":"POST /payroll/entries/payslips","href":"/api-reference/payroll/payslips-create"},{"title":"Get Payroll","openapi":"GET /payroll/{user_id}","href":"/api-reference/payroll/get"},{"title":"List all entries","openapi":"GET /payroll/entries","href":"/api-reference/payroll/entries-list"},{"title":"Delete an entry","openapi":"DELETE /payroll/entries/{entry_id}","href":"/api-reference/payroll/entries-delete"}]},{"group":"Expenditure","pages":[{"title":"Get ONS expenditure","openapi":"GET /expenditure/{user_id}/ons","href":"/api-reference/expenditure/ons"}]},{"group":"Gov Connect","pages":[{"title":"Query Gov Connection","openapi":"POST /gov-connect/entries/connections","href":"/api-reference/gov-connect/connections-create"},{"title":"Get Gov Connect income","openapi":"GET /gov-connect/{user_id}","href":"/api-reference/gov-connect/get"}]},{"group":"Doc Scan","pages":[{"title":"Lists all documents","openapi":"GET /documents","href":"/api-reference/documents/list"},{"title":"Retrieve a specific document","openapi":"GET /documents/{document_id}","href":"/api-reference/documents/get"},{"title":"Delete a document","openapi":"DELETE /documents/{document_id}","href":"/api-reference/documents/delete"},{"title":"Presign bank statement uploads","openapi":"PUT /documents/bank-statements/presign","href":"/api-reference/documents/bank-statements-presign"},{"title":"Upload bank statements","openapi":"PUT /documents/bank-statements","href":"/api-reference/documents/bank-statements-upload"},{"title":"List bank statement submissions","openapi":"GET /bankstatements/{user_id}","href":"/api-reference/documents/bank-statements-get"}]},{"group":"Authorisations","pages":[{"title":"Create an Authorisation Term","openapi":"POST /authorisations/terms","href":"/api-reference/authorisations/terms-create"},{"title":"List Authorisation Terms","openapi":"GET /authorisations/terms","href":"/api-reference/authorisations/terms-list"},{"title":"Get an Authorisation Term","openapi":"GET /authorisations/terms/{term_id}","href":"/api-reference/authorisations/terms-get"},{"title":"Get Latest Term for User","openapi":"GET /authorisations/terms/latest","href":"/api-reference/authorisations/terms-latest"},{"title":"Record Authorisation Acceptance","openapi":"POST /authorisations","href":"/api-reference/authorisations/create"},{"title":"List User Authorisations","openapi":"GET /authorisations","href":"/api-reference/authorisations/list"},{"title":"Revoke an Authorisation","openapi":"PUT /authorisations/{authorisation_id}/revoke","href":"/api-reference/authorisations/revoke"}]},{"group":"Providers","pages":[{"title":"List all providers","openapi":"GET /providers","href":"/api-reference/providers/list"}]},{"group":"Configuration","pages":[{"title":"Get client configuration","openapi":"GET /configuration","href":"/api-reference/configuration/get"},{"title":"Update client configuration","openapi":"PATCH /configuration","description":"Partial updates supported; omitted fields preserve their existing values.","href":"/api-reference/configuration/update"}]},{"group":"Webhooks","pages":[{"title":"Create a Webhook","openapi":"POST /webhooks","href":"/api-reference/webhooks/create"},{"title":"Retrieve a Webhook","openapi":"GET /webhooks/{webhook_id}","description":null,"href":"/api-reference/webhooks/get"},{"title":"List all webhooks","openapi":"GET /webhooks","href":"/api-reference/webhooks/list"},{"title":"Delete a Webhook","openapi":"DELETE /webhooks/{webhook_id}","href":"/api-reference/webhooks/delete"}]}]}]},"basePath":"","title":"Create a Webhook - Teal","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}