Register a URL that Connectly will POST to whenever a subscribed event occurs. You can register multiple endpoints per topic — the only restriction is you cannot register the exact same topic + URL pair twice.
The event field to match on. Supported values: campaign_name, phoneNumbers, botConversation.Note: campaign_name works on any topic including messages — not just delivery_status. It matches events where the conversation is tagged with that campaign name.
You can register multiple webhooks on the same topic pointing to different URLs. All registered endpoints receive matching events — creating a second one does not replace the first.
The exact same topic + URL combination is already registered.
500
Internal server error.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Connectly","colors":{"primary":"#a33eee","light":"#a33eee","dark":"#000000"},"logo":{"light":"https://mintcdn.com/connectly/KvmvAl_4XSs9Yj_O/images/66df6b90acbd4b9628adb50d_Connectly-black.png?fit=max\u0026auto=format\u0026n=KvmvAl_4XSs9Yj_O\u0026q=85\u0026s=3a7c25821de553469c1544b52838d1c9","dark":"https://mintcdn.com/connectly/KvmvAl_4XSs9Yj_O/images/66df6b90acbd4b9628adb50d_Connectly-black.png?fit=max\u0026auto=format\u0026n=KvmvAl_4XSs9Yj_O\u0026q=85\u0026s=3a7c25821de553469c1544b52838d1c9"},"favicon":"https://mintcdn.com/connectly/mcBNMTGsLrCoBsMf/images/favicon.png?fit=max\u0026auto=format\u0026n=mcBNMTGsLrCoBsMf\u0026q=85\u0026s=a07d17c053dc702f03cac8bb27494bb6","background":{"decoration":"grid","color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"links":[],"primary":{"type":"button","label":"Get Started","href":"https://app.connectly.ai"}},"contextual":{"options":["copy","view","download-pdf"],"display":"header"},"interaction":{"drilldown":true},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction"},{"language":"es","href":"es"},{"language":"pt-BR","href":"pt-BR"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"connectly","hasAudioNarration":false,"actualSubdomain":"connectly","customDomains":["docs.connectly.ai"],"gitSource":{"type":"github","owner":"connectlyai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae4b6aea3eed560d7e587d4","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"en","tag":"Developer Documentation","count":65},{"language":"en","tag":"Business Hub","count":22},{"language":"es","tag":"Business Hub","count":20},{"language":"pt-BR","tag":"Business Hub","count":20},{"language":"en","tag":"Inbox","count":13},{"language":"es","tag":"Inbox","count":13},{"language":"pt-BR","tag":"Inbox","count":13},{"language":"en","tag":"AI Features","count":9},{"language":"en","tag":"Messaging","count":8},{"language":"en","tag":"Analytics","count":7},{"language":"en","tag":"Integrations","count":7},{"language":"en","tag":"Webhooks","count":7},{"language":"en","tag":"Agent Graph","count":6},{"language":"en","tag":"Business Management","count":6},{"language":"es","tag":"Analítica","count":3},{"language":"es","tag":"Equipos y tiendas","count":3},{"language":"pt-BR","tag":"Análises","count":3},{"language":"pt-BR","tag":"Times e lojas","count":3},{"language":"es","tag":"Campañas","count":1},{"language":"es","tag":"Gestión de usuarios","count":1},{"language":"es","tag":"Introducción","count":1},{"language":"es","tag":"Herramientas","count":1},{"language":"pt-BR","tag":"Campanhas","count":1},{"language":"pt-BR","tag":"Gestão de usuários","count":1},{"language":"pt-BR","tag":"Introdução","count":1},{"language":"pt-BR","tag":"Ferramentas","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":true},"customCss":[],"page":{"pagePath":"webhooks/create-webhook","slug":"/webhooks/create-webhook","pageMetadata":{"title":"Create Webhook","description":"Register an HTTPS endpoint to receive Connectly webhook events for a given topic 💪","api":"POST /v1/businesses/{businessId}/create/webhooks","hideApiMarker":true,"mode":"wide","href":"/webhooks/create-webhook"},"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 an HTTPS endpoint to receive Connectly webhook events for a given topic 💪\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Expandable,Heading,ParamField,Table}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Register a URL that Connectly will POST to whenever a subscribed event occurs. You can register `,_jsx(_components.strong,{children:`multiple endpoints per topic`}),` — the only restriction is you cannot register the exact same topic + URL pair twice.`]}),`\n`,_jsx(Heading,{level:`2`,id:`endpoint`,children:`Endpoint`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`POST https:`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`//api.connectly.ai/v1/businesses/{businessId}/create/webhooks`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request body`}),`\n`,_jsxs(ParamField,{body:`topic`,type:`string`,required:true,id:`param-topic`,children:[_jsx(_components.p,{children:`The event topic to subscribe to.`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Value`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`messages`})}),_jsx(_components.td,{children:`Inbound WhatsApp messages sent by your customers.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`delivery_status`})}),_jsxs(_components.td,{children:[`Delivery status updates: `,_jsx(_components.code,{children:`sent`}),`, `,_jsx(_components.code,{children:`delivered`}),`, `,_jsx(_components.code,{children:`read`}),`, `,_jsx(_components.code,{children:`delivery_failed`}),`.`]})]})]})]})]}),`\n`,_jsx(ParamField,{body:`address`,type:`string`,required:true,id:`param-address`,children:_jsxs(_components.p,{children:[`Your publicly accessible HTTPS endpoint URL (e.g. `,_jsx(_components.code,{children:`https://example.com/webhook`}),`).`]})}),`\n`,_jsxs(ParamField,{body:`type`,type:`string`,id:`param-type`,children:[_jsxs(_components.p,{children:[`Integration type for this webhook. Defaults to `,_jsx(_components.code,{children:`custom`}),`.`]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Value`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`custom`})}),_jsx(_components.td,{children:`Your own HTTP endpoint.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`zapier`})}),_jsx(_components.td,{children:`Zapier integration.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webengage`})}),_jsx(_components.td,{children:`WebEngage integration.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`integromat_make`})}),_jsx(_components.td,{children:`Integromat / Make integration.`})]})]})]})]}),`\n`,_jsxs(ParamField,{body:`configuration`,type:`object`,id:`param-configuration`,children:[_jsx(_components.p,{children:`Advanced configuration options.`}),_jsxs(Expandable,{title:`configuration properties`,children:[_jsx(ParamField,{body:`echo`,type:`boolean`,id:`param-echo`,children:_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`true`}),`, outbound messages sent by your business are echoed back to this webhook in addition to inbound messages.`]})}),_jsx(ParamField,{body:`channelTypes`,type:`array`,id:`param-channel-types`,children:_jsxs(_components.p,{children:[`List of channel types to filter events by (e.g. `,_jsx(_components.code,{children:`[\"whatsapp\"]`}),`). When omitted, events from all channels are delivered.`]})}),_jsxs(ParamField,{body:`filters`,type:`array`,id:`param-filters`,children:[_jsx(_components.p,{children:`List of filter rules to restrict which events are delivered to this endpoint.`}),_jsxs(Expandable,{title:`filter properties`,children:[_jsxs(ParamField,{body:`field`,type:`string`,id:`param-field`,children:[_jsxs(_components.p,{children:[`The event field to match on. Supported values: `,_jsx(_components.code,{children:`campaign_name`}),`, `,_jsx(_components.code,{children:`phoneNumbers`}),`, `,_jsx(_components.code,{children:`botConversation`}),`.`]}),_jsxs(_components.p,{children:[`Note: `,_jsx(_components.code,{children:`campaign_name`}),` works on `,_jsx(_components.strong,{children:`any topic`}),` including `,_jsx(_components.code,{children:`messages`}),` — not just `,_jsx(_components.code,{children:`delivery_status`}),`. It matches events where the conversation is tagged with that campaign name.`]})]}),_jsx(ParamField,{body:`expression`,type:`string`,id:`param-expression`,children:_jsxs(_components.p,{children:[`Glob-style expression to match against the field value. Use `,_jsx(_components.code,{children:`*`}),` to match any campaign. Use a specific name like `,_jsx(_components.code,{children:`summer-promo-*`}),` to match a subset.`]})})]})]}),_jsxs(ParamField,{body:`webengageConfiguration`,type:`object`,id:`param-webengage-configuration`,children:[_jsxs(_components.p,{children:[`Required when `,_jsx(_components.code,{children:`type`}),` is `,_jsx(_components.code,{children:`webengage`}),`.`]}),_jsxs(Expandable,{title:`webengageConfiguration properties`,children:[_jsx(ParamField,{body:`webengageToken`,type:`string`,id:`param-webengage-token`,children:_jsx(_components.p,{children:`Your WebEngage API token.`})}),_jsx(ParamField,{body:`webengageWebhookUrl`,type:`string`,id:`param-webengage-webhook-url`,children:_jsx(_components.p,{children:`Your WebEngage webhook URL.`})})]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`Register for inbound messages`,id:`register-for-inbound-messages`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.connectly.ai/v1/businesses/{businessId}/create/webhooks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-API-Key: YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"topic\": \"messages\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"address\": \"https://example.com/webhook/messages\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})}),_jsx(Accordion,{title:`Register for delivery status`,id:`register-for-delivery-status`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.connectly.ai/v1/businesses/{businessId}/create/webhooks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-API-Key: YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"topic\": \"delivery_status\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"address\": \"https://example.com/webhook/delivery\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})}),_jsx(Accordion,{title:`With campaign filter and channel type`,id:`with-campaign-filter-and-channel-type`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`14`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`14`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.connectly.ai/v1/businesses/{businessId}/create/webhooks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-API-Key: YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"topic\": \"delivery_status\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"address\": \"https://example.com/webhook/delivery\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"configuration\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"channelTypes\": [\"whatsapp\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"filters\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"field\": \"campaign_name\", \"expression\": \"summer-promo-*\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})}),_jsxs(Accordion,{title:`Multiple endpoints on the same topic`,id:`multiple-endpoints-on-the-same-topic`,children:[_jsx(_components.p,{children:`You can register multiple webhooks on the same topic pointing to different URLs. All registered endpoints receive matching events — creating a second one does not replace the first.`}),_jsx(CodeBlock,{filename:``,numberOfLines:`22`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`22`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# First endpoint — receives all inbound messages`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.connectly.ai/v1/businesses/{businessId}/create/webhooks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-API-Key: YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"topic\": \"messages\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"address\": \"https://example.com/webhook/all-messages\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Second endpoint — receives only campaign-tagged messages`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.connectly.ai/v1/businesses/{businessId}/create/webhooks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-API-Key: YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"topic\": \"messages\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"address\": \"https://example.com/webhook/campaign-messages\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"configuration\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"filters\": [{ \"field\": \"campaign_name\", \"expression\": \"*\" }]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"01ARZ3NDEKTSV4RRFFQ69G5FAV\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Save the returned `,_jsx(_components.code,{children:`id`}),` — you’ll need it to `,_jsx(_components.a,{href:`/webhooks/update-webhook`,children:`update`}),` or `,_jsx(_components.a,{href:`/webhooks/delete-webhook`,children:`delete`}),` this registration.`]}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error responses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`Malformed body or invalid field values.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsxs(_components.td,{children:[`Missing or invalid `,_jsx(_components.code,{children:`X-API-Key`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`The exact same topic + URL combination is already registered.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Internal server error.`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Webhook","description":"Register an HTTPS endpoint to receive Connectly webhook events for a given topic 💪","api":"POST /v1/businesses/{businessId}/create/webhooks","hideApiMarker":true,"mode":"wide","href":"/webhooks/create-webhook"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoint","slug":"endpoint","depth":2,"children":[]},{"title":"Request body","slug":"request-body","depth":2,"children":[]},{"title":"Examples","slug":"examples","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Error responses","slug":"error-responses","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Create Webhook","path":"/v1/businesses/{businessId}/create/webhooks","method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"topic":[{"type":"string","description":"The event topic to subscribe to. Value Description `messages` Inbound WhatsApp messages sent by your customers. `delivery_status` Delivery status updates: `sent` , `delivered` , `read` , `delivery_failed` .","required":true}],"address":[{"type":"string","description":"Your publicly accessible HTTPS endpoint URL (e.g. `https://example.com/webhook` ).","required":true}],"type":[{"type":"string","description":"Integration type for this webhook. Defaults to `custom` . Value Description `custom` Your own HTTP endpoint. `zapier` Zapier integration. `webengage` WebEngage integration. `integromat_make` Integromat / Make integration."}],"configuration":[{"type":"object","properties":{"echo":[{"type":"boolean","description":"When `true` , outbound messages sent by your business are echoed back to this webhook in addition to inbound messages."}],"channelTypes":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"List of channel types to filter events by (e.g. `[\"whatsapp\"]` ). When omitted, events from all channels are delivered."}],"filters":[{"type":"array","items":[{"type":"object","properties":{"field":[{"type":"string","description":"The event field to match on. Supported values: `campaign_name` , `phoneNumbers` , `botConversation` . Note: `campaign_name` works on any topic including `messages` — not just `delivery_status` . It matches events where the conversation is tagged with that campaign name."}],"expression":[{"type":"string","description":"Glob-style expression to match against the field value. Use `*` to match any campaign. Use a specific name like `summer-promo-*` to match a subset."}]}}],"description":"List of filter rules to restrict which events are delivered to this endpoint."}],"webengageConfiguration":[{"type":"object","properties":{"webengageToken":[{"type":"string","description":"Your WebEngage API token."}],"webengageWebhookUrl":[{"type":"string","description":"Your WebEngage webhook URL."}]},"description":"Required when `type` is `webengage` ."}]},"description":"Advanced configuration options."}]}}],"examples":{"example":{"value":{"topic":"\u003cstring>","address":"\u003cstring>","type":"\u003cstring>","configuration":{"echo":true,"channelTypes":[{}],"filters":[{"field":"\u003cstring>","expression":"\u003cstring>"}],"webengageConfiguration":{"webengageToken":"\u003cstring>","webengageWebhookUrl":"\u003cstring>"}}}}}}}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"connectly","siteName":"Connectly","title":"Create Webhook - Connectly","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/webhooks/create-webhook","matchLevel":0},"es":{"href":"/es","matchLevel":4},"pt-BR":{"href":"/pt-BR","matchLevel":4}}},"lastModified":"2026-08-26T17:21:35.408Z","originalFileLocation":"webhooks/create-webhook.mdx","locale":"en"},"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 an HTTPS endpoint to receive Connectly webhook events for a given topic 💪\">\u003cmeta data-mint-head name=\"application-name\" content=\"Connectly\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/connectly/igUy3pqotWr5wvDF/_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/connectly/igUy3pqotWr5wvDF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/connectly/igUy3pqotWr5wvDF/_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/connectly/igUy3pqotWr5wvDF/_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/connectly/igUy3pqotWr5wvDF/_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/connectly/igUy3pqotWr5wvDF/_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/connectly/igUy3pqotWr5wvDF/_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/connectly/igUy3pqotWr5wvDF/_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/connectly/igUy3pqotWr5wvDF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Webhook - Connectly\">\u003cmeta data-mint-head property=\"og:description\" content=\"Register an HTTPS endpoint to receive Connectly webhook events for a given topic 💪\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Connectly\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.connectly.ai/webhooks/create-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://connectly.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+Webhook\u0026amp;description=Register+an+HTTPS+endpoint+to+receive+Connectly+webhook+events+for+a+given+topic+%F0%9F%92%AA\u0026amp;theme=eeaab961cf07ed8c1e76de70\u0026amp;signature=982b14b9149afda49358b6b1cf3a616d0118380d8f8f594c24f1716f31e6ad18\">\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 - Connectly\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Register an HTTPS endpoint to receive Connectly webhook events for a given topic 💪\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://connectly.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+Webhook\u0026amp;description=Register+an+HTTPS+endpoint+to+receive+Connectly+webhook+events+for+a+given+topic+%F0%9F%92%AA\u0026amp;theme=eeaab961cf07ed8c1e76de70\u0026amp;signature=982b14b9149afda49358b6b1cf3a616d0118380d8f8f594c24f1716f31e6ad18\">\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/connectly/igUy3pqotWr5wvDF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Connectly\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#a33eee\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.connectly.ai/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/webhooks/create-webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.connectly.ai/#organization\",\"name\":\"Connectly\",\"url\":\"https://docs.connectly.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/connectly/KvmvAl_4XSs9Yj_O/images/66df6b90acbd4b9628adb50d_Connectly-black.png?fit=max\u0026auto=format\u0026n=KvmvAl_4XSs9Yj_O\u0026q=85\u0026s=3a7c25821de553469c1544b52838d1c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.connectly.ai#website\",\"name\":\"Connectly\",\"url\":\"https://docs.connectly.ai\",\"publisher\":{\"@id\":\"https://docs.connectly.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.connectly.ai/webhooks/create-webhook#webpage\",\"url\":\"https://docs.connectly.ai/webhooks/create-webhook\",\"name\":\"Create Webhook\",\"description\":\"Register an HTTPS endpoint to receive Connectly webhook events for a given topic 💪\",\"dateModified\":\"2026-08-26T17:21:35.408Z\",\"isPartOf\":{\"@id\":\"https://docs.connectly.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.connectly.ai/webhooks/create-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.connectly.ai/webhooks/create-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.connectly.ai/webhooks/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Webhook\",\"item\":\"https://docs.connectly.ai/webhooks/create-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.connectly.ai/webhooks/create-webhook#apireference\",\"headline\":\"Create Webhook\",\"name\":\"Create Webhook\",\"description\":\"Register an HTTPS endpoint to receive Connectly webhook events for a given topic 💪\",\"url\":\"https://docs.connectly.ai/webhooks/create-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.connectly.ai/webhooks/create-webhook#webpage\"},\"dateModified\":\"2026-08-26T17:21:35.408Z\",\"publisher\":{\"@id\":\"https://docs.connectly.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.connectly.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Connectly\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Connectly","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Developer Documentation","groups":[{"group":"Get Started","icon":"rocket","pages":[{"title":"Introduction","mode":"wide","href":"/introduction"},{"title":"Authentication \u0026 API Keys","mode":"wide","href":"/get-started/authentication-and-api-keys"},{"title":"Quick Start","mode":"wide","href":"/get-started/quick-start"}]},{"group":"Campaigns","icon":"arrow-pointer","pages":[{"title":"Campaigns Overview","sidebarTitle":"Overview","mode":"wide","href":"/campaigns/overview"},{"title":"Send Campaigns","api":"POST /v1/businesses/{businessId}/send/campaigns","hideApiMarker":true,"mode":"wide","href":"/campaigns/send-campaigns"},{"title":"Send to an Audience","mode":"wide","href":"/campaigns/send-to-audience"},{"title":"WhatsApp Flow builder","mode":"wide","href":"/campaigns/whatsapp-flow-builder"}]},{"group":"Audiences","icon":"users","pages":[{"title":"Audiences Overview","sidebarTitle":"Overview","mode":"wide","href":"/audiences/overview"},{"title":"Upload Recipients","mode":"wide","href":"/audiences/upload-recipients"},{"title":"Manage Audiences","mode":"wide","href":"/audiences/manage-audiences"}]},{"group":"Messaging","icon":"message-dot","pages":[{"title":"Messaging Overview","sidebarTitle":"Overview","mode":"wide","href":"/messaging/overview"},{"title":"Send Template Messages","api":"POST /v1/businesses/{businessId}/send/whatsapp_templated_messages","hideApiMarker":true,"mode":"wide","href":"/messaging/template-messages"},{"title":"Send Session Messages","api":"POST /v1/businesses/{businessId}/send/messages","hideApiMarker":true,"mode":"wide","href":"/messaging/session-messages"},{"title":"Send Typing Indicators","api":"POST /v1/businesses/{businessId}/send/typing_indicators","hideApiMarker":true,"mode":"wide","href":"/messaging/typing-indicators"},{"title":"WhatsApp Flows","href":"/messaging/whatsapp-flows"},{"title":"WhatsApp Flow Endpoints","href":"/messaging/whatsapp-flow-endpoints"},{"title":"Error Codes","mode":"wide","href":"/messaging/error-codes"},{"title":"Business-Scoped User IDs (BSUID)","mode":"wide","href":"/messaging/bsuid"}]},{"group":"Opt-Outs","icon":"ban","pages":[{"title":"Opt-Outs Overview","sidebarTitle":"Overview","mode":"wide","href":"/opt-outs/overview"},{"title":"Add Opt-Outs","api":"POST /v1/businesses/{businessId}/add/opt_outs","hideApiMarker":true,"mode":"wide","href":"/opt-outs/add-opt-outs"},{"title":"Remove Opt-Outs","api":"POST /v1/businesses/{businessId}/remove/opt_outs","hideApiMarker":true,"mode":"wide","href":"/opt-outs/remove-opt-outs"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks Overview","sidebarTitle":"Overview","mode":"wide","href":"/webhooks/overview"},{"title":"Webhook Payload Reference","sidebarTitle":"Payload Reference","mode":"wide","href":"/webhooks/payload-types"},{"title":"Webhook Keys","description":"Webhook keys are HMAC signing secrets used to verify that webhook payloads come from Connectly. One active key per business at a time 🔑","mode":"wide","href":"/webhooks/webhook-keys"},{"title":"Create Webhook","api":"POST /v1/businesses/{businessId}/create/webhooks","hideApiMarker":true,"mode":"wide","href":"/webhooks/create-webhook"},{"title":"Get Webhooks","description":"Retrieve all webhook registrations for your business 🤝","api":"GET /v1/businesses/{businessId}/webhooks","hideApiMarker":true,"mode":"wide","href":"/webhooks/get-webhooks"},{"title":"Update Webhook","api":"PUT /v1/businesses/{businessId}/update/webhooks/{webhookId}","hideApiMarker":true,"mode":"wide","href":"/webhooks/update-webhook"},{"title":"Delete Webhook","api":"DELETE /v1/businesses/{businessId}/delete/webhooks/{webhookId}","hideApiMarker":true,"mode":"wide","href":"/webhooks/delete-webhook"}]},{"group":"Assets","icon":"cassette-betamax","pages":[{"title":"Assets Overview","sidebarTitle":"Overview","mode":"wide","href":"/assets/overview"},{"title":"Create Asset","api":"POST /v1/businesses/{businessId}/assets","hideApiMarker":true,"mode":"wide","href":"/assets/create-asset"},{"title":"Get Asset","api":"GET /v1/businesses/{businessId}/assets/{assetId}","hideApiMarker":true,"mode":"wide","href":"/assets/get-asset"}]},{"group":"AI Features","icon":"user-robot","pages":[{"group":"Sofia AI","expanded":false,"pages":[{"title":"Sofia AI Overview","sidebarTitle":"Overview","mode":"wide","href":"/ai/sofia-ai"},{"title":"Invoke Sofia AI","api":"POST /external/v1/ai/agent_graph/invoke","hideApiMarker":true,"mode":"wide","href":"/ai/sofia-ai-invoke"}]},{"group":"Agent Graph","expanded":false,"pages":[{"title":"Agent Graph Overview","sidebarTitle":"Overview","mode":"wide","href":"/ai/agent-graph-overview"},{"title":"Init Session","api":"POST /external/v1/ai/agent_graph/init","hideApiMarker":true,"mode":"wide","href":"/ai/agent-graph-init"},{"title":"Invoke (Stream)","api":"POST /external/v1/ai/agent_graph/invoke","hideApiMarker":true,"mode":"wide","href":"/ai/agent-graph-invoke"},{"title":"Invoke (Sync)","api":"POST /external/v1/ai/agent_graph/invoke_sync","hideApiMarker":true,"mode":"wide","href":"/ai/agent-graph-invoke-sync"},{"title":"Close Session","api":"POST /external/v1/ai/agent_graph/close","hideApiMarker":true,"mode":"wide","href":"/ai/agent-graph-close"},{"title":"Health Check","api":"POST /external/v1/ai/agent_graph/health","hideApiMarker":true,"mode":"wide","href":"/ai/agent-graph-health"}]},{"title":"NDJSON Streaming","mode":"wide","href":"/ai/parsing-ndjson"}]},{"group":"Analytics","icon":"analytics","pages":[{"title":"Campaign Report","mode":"wide","href":"/analytics/campaign-report"},{"title":"Reports API","api":"GET /v1/businesses/{businessId}/reporting/reports","hideApiMarker":true,"mode":"wide","href":"/analytics/reports-api"},{"title":"Conversion Reporting","api":"POST /external/v1/businesses/{business_id}/conversion_events","hideApiMarker":true,"mode":"wide","href":"/analytics/conversion-reporting"},{"title":"Report Webhooks","mode":"wide","href":"/analytics/report-webhooks"}]},{"group":"Business Management","icon":"briefcase","pages":[{"title":"Business Management Overview","sidebarTitle":"Overview","mode":"wide","href":"/business-management/overview"},{"group":"Templates","expanded":false,"pages":[{"title":"Templates Overview","sidebarTitle":"Overview","mode":"wide","href":"/business-management/template-management"},{"title":"Create Template","api":"POST /v1/businesses/{businessId}/create/template","hideApiMarker":true,"mode":"wide","href":"/business-management/create-template"},{"title":"Get Templates","api":"POST /v1/businesses/{businessId}/get/templates","hideApiMarker":true,"mode":"wide","href":"/business-management/get-templates"},{"title":"Delete Template","api":"DELETE /v1/businesses/{businessId}/templates/{templateGroupId}","hideApiMarker":true,"mode":"wide","href":"/business-management/delete-template"}]},{"group":"Quality Signals","expanded":false,"pages":[{"title":"Get Quality Signals","api":"GET /v1/businesses/{businessId}/get/quality_signals","hideApiMarker":true,"mode":"wide","href":"/business-management/quality-signals"}]}]},{"group":"Integrations","icon":"integral","pages":[{"title":"Integrations Overview","sidebarTitle":"Overview","mode":"wide","href":"/integrations/overview"},{"title":"Zendesk","mode":"wide","href":"/integrations/zendesk"},{"title":"Intercom","mode":"wide","href":"/integrations/intercom"},{"title":"WebEngage","mode":"wide","href":"/integrations/webengage"},{"title":"MoEngage (Alpha)","mode":"wide","href":"/integrations/mo-engage-alpha"},{"title":"Klaviyo","mode":"wide","href":"/integrations/klaviyo"},{"title":"Tools","mode":"wide","href":"/integrations/tools"}]},{"group":"Tools","icon":"wrench","pages":[{"title":"Tools Overview","sidebarTitle":"Overview","mode":"wide","href":"/tools/overview"}]},{"group":"Webchat","icon":"comments","tag":"Preview","pages":[{"group":"Guides","expanded":false,"pages":[{"title":"Connectly Webchat","sidebarTitle":"Overview","mode":"wide","href":"/webchat/overview"},{"title":"Install","sidebarTitle":"Install","mode":"wide","href":"/webchat/install"},{"title":"Configure","sidebarTitle":"Configure","mode":"wide","href":"/webchat/configure"},{"title":"Sign in your users","sidebarTitle":"Sign-in","mode":"wide","href":"/webchat/sign-in"},{"title":"API","sidebarTitle":"API","mode":"wide","href":"/webchat/api"},{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","mode":"wide","href":"/webchat/troubleshooting"}]}]},{"group":"Resources","icon":"question-circle","pages":[{"title":"FAQ","mode":"wide","href":"/resources/faq"},{"title":"Migrate WhatsApp Accounts","mode":"wide","href":"/business-management/migrate-whatsapp"}]}]},{"tab":"Business Hub","pages":[{"title":"Business Hub","href":"/business-hub/campaigns/ctwa"}]}]},{"language":"es","pages":[{"title":"es","href":"/es"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR"}]}]},"basePath":"","title":"Create Webhook - Connectly","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","b0f84f53ff"],"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","Page-C945cI-W.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","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"]}