WhatsApp Webhooks API — Subscribe to Delivery & Inbound Events
Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.
Two separate webhook systems work together in a Vobiz WhatsApp integration. See the Webhooks overview for the conceptual split.
System
Direction
Purpose
Inbound
Meta → Vobiz
Meta delivers raw WhatsApp Cloud API events to a Vobiz endpoint. Platform plumbing you set once in your Meta App.
Outbound
Vobiz → your server
Vobiz forwards a signed event envelope to the endpoint URL you register here.
All endpoints are under the base URL https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp, except the inbound Meta callback which is at https://api.vobiz.ai/api/v1/webhooks/whatsapp.
Inbound (Meta → Vobiz)
These endpoints are called by Meta, not by your application. You normally configure the callback URL and verify token once inside your Meta App. The examples below are for understanding and local simulation only.
Verify webhook (challenge-response)
GET https://api.vobiz.ai/api/v1/webhooks/whatsapp
When you register the webhook in your Meta App, Meta sends a GET with the standard hub.* query params. Vobiz echoes the hub.challenge back as text/plain200only whenhub.verify_token matches the token configured on the Vobiz side. No auth header is used on this endpoint.
Param
Description
hub.mode
Always subscribe.
hub.verify_token
The verify token you set. Must match the Vobiz-side token or the request is rejected with 403.
hub.challenge
Random string Meta expects echoed back verbatim.
Simulate Meta's verification
curl -X GET \ "https://api.vobiz.ai/api/v1/webhooks/whatsapp?hub.mode=subscribe&hub.verify_token=<your-verify-token>&hub.challenge=test_challenge_123"
200 OK
test_challenge_123
Receive webhook (Meta callback)
POST https://api.vobiz.ai/api/v1/webhooks/whatsapp
Meta POSTs the WhatsApp Cloud API event here. Meta signs the request with X-Hub-Signature-256: sha256=<hex HMAC-SHA256 of the raw body, keyed by your Meta App Secret>. Vobiz verifies that signature and enforces a replay window, rejecting stale or future-dated payloads. The body is the standard Meta envelope (object = whatsapp_business_account, entry[].changes[].value carrying messaging_product, metadata, and any of contacts[], messages[], statuses[], calls[]).
After Vobiz accepts an inbound Meta event, it fans it out to your registered subscriptions as an outbound webhook.
Outbound (Vobiz to your server)
Register an HTTPS endpoint and a shared secret. Vobiz then delivers a signed event envelope to your endpoint for the three supported event types. See the Event Reference for envelope and payload shapes, and the overview for signature verification.Authentication (subscription management): every request needs the X-Auth-ID: MA_XXXXXXXX and X-Auth-Token: YOUR_AUTH_TOKEN headers, and the {auth_id} in the path must be the account those credentials belong to. Get credentials from console.vobiz.ai.
Create webhook subscription
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Webhook/
Register an HTTPS endpoint to receive events. Subscribing a URL you already have replaces its secret and reactivates it. A missing url or secret returns 400. Returns 201 Created; the secret isn’t returned.
Field
Required
Description
url
Yes
HTTPS endpoint that will receive event deliveries. Sending a URL you already subscribed replaces its secret.
secret
Yes
Shared secret used to sign deliveries (HMAC-SHA256 → X-Webhook-Signature). Store it securely - it is never returned in any response.
The event_type values are message.inbound for a received message, message.status for a delivery status update (with status ∈ sent/delivered/read/failed), and call. followed by the WhatsApp call event (e.g. call.connect, call.terminate). The payload is the WhatsApp Business Platform webhook payload that triggered the event, unchanged.Vobiz waits up to 5 seconds for your endpoint to respond and delivers each event once. Return any 2xx status quickly, and do heavier processing after you respond.
Verify X-Webhook-Signature against the raw body before processing - compute HMAC-SHA256 with your secret, hex-encode, and constant-time compare. See the signature example.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Vobiz","colors":{"primary":"#E83C00","light":"#E86A00","dark":"#c93400"},"logo":{"light":"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/light.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=8e1f6273f626f638f46d6df526d4775c","dark":"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/dark.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=57b37e5694f01e6933c9ec02a871250a","href":"https://www.vobiz.ai/docs/introduction"},"favicon":"https://mintcdn.com/vobizai/BDRzOqCvIsC8CJvN/favicon.svg?fit=max\u0026auto=format\u0026n=BDRzOqCvIsC8CJvN\u0026q=85\u0026s=b38182f12bc6b0e3a5df2a8ae1474f83","api":{"openapi":["openapi.yaml","openapi-sms.yaml","openapi-whatsapp.yaml"],"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true},"mdx":{"auth":{"method":"key","name":"X-Auth-Token"},"server":"https://api.vobiz.ai"}},"appearance":{"default":"dark"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"mailto:support@vobiz.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://console.vobiz.ai"}},"footer":{"socials":{"x":"https://x.com/Vobiz_Ai","github":"https://github.com/vobiz-ai","linkedin":"https://linkedin.com/company/vobizai"}},"seo":{"metatags":{"canonical":"https://www.vobiz.ai/docs","og:site_name":"Vobiz Docs","og:type":"website","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@Vobiz_Ai","twitter:creator":"@Vobiz_Ai","theme-color":"#E83C00","color-scheme":"dark light","author":"Vobiz","publisher":"Vobiz","copyright":"Copyright 2025 Vobiz","reply-to":"support@vobiz.ai","robots":"index, follow","format-detection":"telephone=no","referrer":"origin-when-cross-origin","rating":"general","language":"en","category":"Technology","coverage":"Worldwide","distribution":"global","target":"all"},"indexing":"all"},"integrations":{"ga4":{"measurementId":"G-YD6M3FF3P4"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark"},"markdown":{"schema":true},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"API Status","icon":"signal","href":"https://status.vobiz.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vobizai","hasAudioNarration":false,"actualSubdomain":"vobizai","customDomains":["www.vobiz.ai"],"gitSource":{"type":"github","owner":"vobiz-ai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae8948acb9fa025302af88e"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6b00db3c4dbe5d10f9185131","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":386},{"language":"default","tag":"Voice \u0026 XML","count":119},{"language":"default","tag":"Documentation","count":99},{"language":"default","tag":"SMS \u0026 RCS","count":92},{"language":"default","tag":"Blogs","count":82},{"language":"default","tag":"Articles","count":80},{"language":"default","tag":"Integrations","count":79},{"language":"default","tag":"Examples \u0026 Tutorials","count":59},{"language":"default","tag":"Regular APIs","count":40},{"language":"default","tag":"SIP Trunking","count":32}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@vobiz.ai","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","href":"/docs/_mintlify/custom/vobizai/c4c76a1b5bc930af/custom.css"}]}
{"page":{"pagePath":"whatsapp/api/webhooks","slug":"/whatsapp/api/webhooks","pageMetadata":{"title":"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events","description":"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.","openapi":"openapi-whatsapp.yaml POST /api/v1/Account/{auth_id}/WhatsApp/Webhook/","keywords":["WhatsApp webhooks API","Meta webhooks WhatsApp","WhatsApp webhook configuration","WhatsApp event subscriptions","WhatsApp delivery status webhook","WhatsApp inbound message webhook","WhatsApp webhook endpoints","WABA webhook setup","real-time WhatsApp events","WhatsApp webhook payload","WhatsApp Vobiz subscriptions","WhatsApp event forwarding","WhatsApp webhook URL","WhatsApp callback API","WhatsApp webhook security","X-Webhook-Signature","X-Hub-Signature-256","WhatsApp webhook integration","WhatsApp event API India","WhatsApp message status webhook"],"href":"/whatsapp/api/webhooks"},"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: \"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Two separate webhook systems work together in a Vobiz WhatsApp integration. See the `,_jsx(_components.a,{href:`/whatsapp/webhooks`,children:`Webhooks overview`}),` for the conceptual split.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`System`}),_jsx(_components.th,{children:`Direction`}),_jsx(_components.th,{children:`Purpose`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Inbound`})}),_jsx(_components.td,{children:`Meta → Vobiz`}),_jsx(_components.td,{children:`Meta delivers raw WhatsApp Cloud API events to a Vobiz endpoint. Platform plumbing you set once in your Meta App.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Outbound`})}),_jsx(_components.td,{children:`Vobiz → your server`}),_jsx(_components.td,{children:`Vobiz forwards a signed event envelope to the endpoint URL you register here.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`All endpoints are under the base URL `,_jsx(_components.code,{children:`https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp`}),`, except the inbound Meta callback which is at `,_jsx(_components.code,{children:`https://api.vobiz.ai/api/v1/webhooks/whatsapp`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`inbound-meta-→-vobiz`,children:`Inbound (Meta → Vobiz)`}),`\n`,_jsxs(_components.p,{children:[`These endpoints are called `,_jsx(_components.strong,{children:`by Meta`}),`, not by your application. You normally configure the callback URL and verify token once inside your Meta App. The examples below are for understanding and local simulation only.`]}),`\n`,_jsx(Heading,{level:`3`,id:`verify-webhook-challenge-response`,children:`Verify webhook (challenge-response)`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`GET`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` https://api.vobiz.ai/api/v1/webhooks/whatsapp`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`When you register the webhook in your Meta App, Meta sends a `,_jsx(_components.code,{children:`GET`}),` with the standard `,_jsx(_components.code,{children:`hub.*`}),` query params. Vobiz echoes the `,_jsx(_components.code,{children:`hub.challenge`}),` back as `,_jsx(_components.code,{children:`text/plain`}),` `,_jsx(_components.code,{children:`200`}),` `,_jsx(_components.strong,{children:`only when`}),` `,_jsx(_components.code,{children:`hub.verify_token`}),` matches the token configured on the Vobiz side. `,_jsx(_components.strong,{children:`No auth header`}),` is used on this endpoint.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Param`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hub.mode`})}),_jsxs(_components.td,{children:[`Always `,_jsx(_components.code,{children:`subscribe`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hub.verify_token`})}),_jsxs(_components.td,{children:[`The verify token you set. Must match the Vobiz-side token or the request is rejected with `,_jsx(_components.code,{children:`403`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hub.challenge`})}),_jsx(_components.td,{children:`Random string Meta expects echoed back verbatim.`})]})]})]}),`\n`,_jsx(CodeBlock,{filename:`Simulate Meta's verification`,numberOfLines:`2`,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:`2`,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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.vobiz.ai/api/v1/webhooks/whatsapp?hub.mode=subscribe\u0026hub.verify_token=\u003cyour-verify-token>\u0026hub.challenge=test_challenge_123\"`})}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`200 OK`,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`test_challenge_123`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`3`,id:`receive-webhook-meta-callback`,children:`Receive webhook (Meta callback)`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`POST`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` https://api.vobiz.ai/api/v1/webhooks/whatsapp`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Meta `,_jsx(_components.code,{children:`POST`}),`s the WhatsApp Cloud API event here. Meta signs the request with `,_jsx(_components.code,{children:`X-Hub-Signature-256: sha256=\u003chex HMAC-SHA256 of the raw body, keyed by your Meta App Secret>`}),`. Vobiz verifies that signature and enforces a `,_jsx(_components.strong,{children:`replay window`}),`, rejecting stale or future-dated payloads. The body is the standard Meta envelope (`,_jsx(_components.code,{children:`object`}),` = `,_jsx(_components.code,{children:`whatsapp_business_account`}),`, `,_jsx(_components.code,{children:`entry[].changes[].value`}),` carrying `,_jsx(_components.code,{children:`messaging_product`}),`, `,_jsx(_components.code,{children:`metadata`}),`, and any of `,_jsx(_components.code,{children:`contacts[]`}),`, `,_jsx(_components.code,{children:`messages[]`}),`, `,_jsx(_components.code,{children:`statuses[]`}),`, `,_jsx(_components.code,{children:`calls[]`}),`).`]}),`\n`,_jsx(CodeBlock,{filename:`Simulate a delivery status callback`,numberOfLines:`5`,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:`5`,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:` -X`}),_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:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.vobiz.ai/api/v1/webhooks/whatsapp\"`}),_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:` -H`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Hub-Signature-256: sha256=\u003chex_hmac_of_raw_body>\"`}),_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:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"object\":\"whatsapp_business_account\",\"entry\":[{\"id\":\"\u003cwaba_id>\",\"changes\":[{\"field\":\"messages\",\"value\":{\"messaging_product\":\"whatsapp\",\"metadata\":{\"display_phone_number\":\"919876543210\",\"phone_number_id\":\"\u003cphone_number_id>\"},\"statuses\":[{\"id\":\"wamid.test\",\"status\":\"delivered\",\"recipient_id\":\"918888888888\",\"timestamp\":\"1711360805\"}]}}]}]}'`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`200 OK`,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`// Empty body on success`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`After Vobiz accepts an inbound Meta event, it fans it out to your registered subscriptions as an `,_jsx(_components.a,{href:`#outbound-vobiz-to-your-server`,children:`outbound webhook`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`outbound-vobiz-to-your-server`,children:`Outbound (Vobiz to your server)`}),`\n`,_jsxs(_components.p,{children:[`Register an HTTPS endpoint and a shared secret. Vobiz then delivers a signed event envelope to your endpoint for the three supported event types. See the `,_jsx(_components.a,{href:`/whatsapp/webhooks/events`,children:`Event Reference`}),` for envelope and payload shapes, and the `,_jsx(_components.a,{href:`/whatsapp/webhooks#verifying-the-signature`,children:`overview`}),` for signature verification.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Authentication (subscription management):`}),` every request needs the `,_jsx(_components.code,{children:`X-Auth-ID: MA_XXXXXXXX`}),` and `,_jsx(_components.code,{children:`X-Auth-Token: YOUR_AUTH_TOKEN`}),` headers, and the `,_jsx(_components.code,{children:`{auth_id}`}),` in the path must be the account those credentials belong to. Get credentials from `,_jsx(_components.a,{href:`https://console.vobiz.ai`,children:`console.vobiz.ai`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`create-webhook-subscription`,children:`Create webhook subscription`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`POST`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Webhook/`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Register an HTTPS endpoint to receive events. Subscribing a URL you already have replaces its secret and reactivates it. A missing `,_jsx(_components.code,{children:`url`}),` or `,_jsx(_components.code,{children:`secret`}),` returns `,_jsx(_components.code,{children:`400`}),`. Returns `,_jsx(_components.code,{children:`201 Created`}),`; the secret isn’t returned.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`url`})}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`HTTPS endpoint that will receive event deliveries. Sending a URL you already subscribed replaces its secret.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`secret`})}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`Shared secret used to sign deliveries (HMAC-SHA256 → `,_jsx(_components.code,{children:`X-Webhook-Signature`}),`). Store it securely - it is `,_jsx(_components.strong,{children:`never`}),` returned in any response.`]})]})]})]}),`\n`,_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`6`,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:`6`,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:` -X`}),_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:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/Webhook/\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Auth-ID: MA_XXXXXXXX\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Auth-Token: YOUR_AUTH_TOKEN\"`}),_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:` -H`}),_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:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"url\":\"https://example.com/webhooks/whatsapp\",\"secret\":\"YOUR_WEBHOOK_SECRET\"}'`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`201 Created`,numberOfLines:`7`,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:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,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:`\"6a1c3e5b-7d9f-4b2a-8c4e-6f8a0b2c4d16\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/webhooks/whatsapp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-03-25T10:00:00Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-03-25T10:00:00Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`id`})}),_jsx(_components.td,{children:`string (UUID)`}),_jsx(_components.td,{children:`Subscription identifier.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`url`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Your registered HTTPS endpoint.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Subscription state, for example `,_jsx(_components.code,{children:`active`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`created_at`})}),_jsx(_components.td,{children:`string (RFC3339, UTC)`}),_jsx(_components.td,{children:`Creation timestamp.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`updated_at`})}),_jsx(_components.td,{children:`string (RFC3339, UTC)`}),_jsx(_components.td,{children:`Last-update timestamp.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`list-webhook-subscriptions`,children:`List webhook subscriptions`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`GET`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Webhook/`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Returns the webhook subscriptions for your account, newest first. The `,_jsx(_components.code,{children:`secret`}),` is never included.`]}),`\n`,_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,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:`4`,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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/Webhook/\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Auth-ID: MA_XXXXXXXX\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Auth-Token: YOUR_AUTH_TOKEN\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`200 OK`,numberOfLines:`11`,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:`11`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,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:`\"6a1c3e5b-7d9f-4b2a-8c4e-6f8a0b2c4d16\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/webhooks/whatsapp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-03-25T10:00:00Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-03-25T10:00:00Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`delete-webhook-subscription`,children:`Delete webhook subscription`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`DELETE`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Webhook/{id}/`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Remove a subscription by its UUID. Vobiz stops delivering events to that URL. Returns `,_jsx(_components.code,{children:`204 No Content`}),`, or `,_jsx(_components.code,{children:`404`}),` for an unknown subscription.`]}),`\n`,_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,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:`4`,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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` DELETE`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/Webhook/6a1c3e5b-7d9f-4b2a-8c4e-6f8a0b2c4d16/\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Auth-ID: MA_XXXXXXXX\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Auth-Token: YOUR_AUTH_TOKEN\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`204 No Content`,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`// Empty body on success`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`delivery-to-your-endpoint`,children:`Delivery to your endpoint`}),`\n`,_jsxs(_components.p,{children:[`When an event fires, Vobiz sends a `,_jsx(_components.code,{children:`POST`}),` to your registered `,_jsx(_components.code,{children:`url`}),` with:`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Headers`})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Header`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`X-Webhook-Signature`})}),_jsxs(_components.td,{children:[`Hex-encoded HMAC-SHA256 of the exact raw request body, keyed by your subscription `,_jsx(_components.code,{children:`secret`}),`. `,_jsx(_components.strong,{children:`No`}),` `,_jsx(_components.code,{children:`sha256=`}),` prefix - just the hex digest.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`X-Webhook-Event`})}),_jsxs(_components.td,{children:[`The event type, equal to the body’s `,_jsx(_components.code,{children:`event_type`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Content-Type`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`application/json`}),`.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Body`}),` - the common envelope (`,_jsx(_components.a,{href:`/whatsapp/webhooks/events#common-envelope`,children:`full reference`}),`):`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,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:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"event_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"f4c1a0d2-3b6e-4a9c-8e2f-0a1b2c3d4e5f\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"event_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message.inbound\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"MA_XXXXXXXX\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"occurred_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-03-25T10:00:00Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"payload\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`event_type`}),` values are `,_jsx(_components.code,{children:`message.inbound`}),` for a received message, `,_jsx(_components.code,{children:`message.status`}),` for a delivery status update (with `,_jsx(_components.code,{children:`status`}),` ∈ `,_jsx(_components.code,{children:`sent`}),`/`,_jsx(_components.code,{children:`delivered`}),`/`,_jsx(_components.code,{children:`read`}),`/`,_jsx(_components.code,{children:`failed`}),`), and `,_jsx(_components.code,{children:`call.`}),` followed by the WhatsApp call event (e.g. `,_jsx(_components.code,{children:`call.connect`}),`, `,_jsx(_components.code,{children:`call.terminate`}),`). The `,_jsx(_components.code,{children:`payload`}),` is the WhatsApp Business Platform webhook payload that triggered the event, unchanged.`]}),`\n`,_jsxs(_components.p,{children:[`Vobiz waits up to 5 seconds for your endpoint to respond and delivers each event once. Return any `,_jsx(_components.code,{children:`2xx`}),` status quickly, and do heavier processing after you respond.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Verify `,_jsx(_components.code,{children:`X-Webhook-Signature`}),` against the `,_jsx(_components.strong,{children:`raw`}),` body before processing - compute HMAC-SHA256 with your `,_jsx(_components.code,{children:`secret`}),`, hex-encode, and constant-time compare. See the `,_jsx(_components.a,{href:`/whatsapp/webhooks#verifying-the-signature`,children:`signature example`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`related-topics`,children:`Related Topics`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/whatsapp/webhooks`,children:`Webhooks Overview →`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/whatsapp/webhooks/events`,children:`Webhook Event Reference →`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/whatsapp/api/send-message`,children:`Send Message API →`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/whatsapp/messaging/inbox`,children:`Inbox Management →`})}),`\n`]})]})}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":"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events","description":"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.","openapi":"openapi-whatsapp.yaml POST /api/v1/Account/{auth_id}/WhatsApp/Webhook/","keywords":["WhatsApp webhooks API","Meta webhooks WhatsApp","WhatsApp webhook configuration","WhatsApp event subscriptions","WhatsApp delivery status webhook","WhatsApp inbound message webhook","WhatsApp webhook endpoints","WABA webhook setup","real-time WhatsApp events","WhatsApp webhook payload","WhatsApp Vobiz subscriptions","WhatsApp event forwarding","WhatsApp webhook URL","WhatsApp callback API","WhatsApp webhook security","X-Webhook-Signature","X-Hub-Signature-256","WhatsApp webhook integration","WhatsApp event API India","WhatsApp message status webhook"],"href":"/whatsapp/api/webhooks"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Inbound (Meta → Vobiz)","slug":"inbound-meta-→-vobiz","depth":2,"children":[{"title":"Verify webhook (challenge-response)","slug":"verify-webhook-challenge-response","depth":3,"children":[]},{"title":"Receive webhook (Meta callback)","slug":"receive-webhook-meta-callback","depth":3,"children":[]}]},{"title":"Outbound (Vobiz to your server)","slug":"outbound-vobiz-to-your-server","depth":2,"children":[{"title":"Create webhook subscription","slug":"create-webhook-subscription","depth":3,"children":[]},{"title":"List webhook subscriptions","slug":"list-webhook-subscriptions","depth":3,"children":[]},{"title":"Delete webhook subscription","slug":"delete-webhook-subscription","depth":3,"children":[]}]},{"title":"Delivery to your endpoint","slug":"delivery-to-your-endpoint","depth":2,"children":[]},{"title":"Related Topics","slug":"related-topics","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/vobizai/478834ae2c200a0e/blog-schema.js","/docs/_mintlify/custom/vobizai/13b0cd7ec6e39877/anchor-link-text.js"],"openApiReferenceData":{"operation":{"tags":["Webhooks"],"summary":"Create a webhook subscription","description":"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.","operationId":"whatsapp-create-webhook","requestBody":"0c2d1e8f-0297-415b-9295-26c6e56f517a","responses":{"201":"81ea4e94-2c56-413b-b3fc-f55b64f5e245","400":"15ca5433-31af-4849-9672-24da2650f327","401":"884b62a0-ae57-408e-b1af-afd8697be238","403":"9efb6fc9-69cc-46e7-ae17-4e17eaf9045d"},"method":"post","type":"path","servers":["ca7d3c8e-f917-4390-a962-8336b70e4a60"],"security":["d8ef9c4b-f6c6-4cce-83d2-a8fc5d3da734"],"path":"/api/v1/Account/{auth_id}/WhatsApp/Webhook/","baseUrlOptions":["https://api.vobiz.ai"],"title":"Create a webhook subscription","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.url":"https://example.com/webhooks/whatsapp","body.secret":"YOUR_WEBHOOK_SECRET"}]},"dependencies":{"parameters":{"108daa8d-0a74-434b-8ad7-f50ca4e6c2b9":{"name":"auth_id","in":"path","required":true,"description":"Your account Auth ID. It must match the `X-Auth-ID` header.","schema":{"type":"string","example":"MA_XXXXXXXX","isRequired":true,"description":"Your account Auth ID. It must match the `X-Auth-ID` header.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","secret"],"properties":{"url":{"type":"string","format":"uri","description":"The HTTPS URL that receives event deliveries. Sending a URL you already subscribed updates its secret.","example":"https://example.com/webhooks/whatsapp","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"secret":{"type":"string","description":"Shared secret used to sign deliveries (HMAC-SHA256, hex-encoded, in `X-Webhook-Signature`). Responses don't include it.","example":"YOUR_WEBHOOK_SECRET","isRequired":true,"uniqueKey":"secret","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"url":"https://example.com/webhooks/whatsapp","secret":"YOUR_WEBHOOK_SECRET"},"examples":{"Example":{"title":"Example","value":{"url":"https://example.com/webhooks/whatsapp","secret":"YOUR_WEBHOOK_SECRET"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"81ea4e94-2c56-413b-b3fc-f55b64f5e245":{"description":"The subscription. The secret is not returned.","content":{"application/json":{"schema":{"type":"object","required":["id","url","status","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Subscription ID.","example":"6a1c3e5b-7d9f-4b2a-8c4e-6f8a0b2c4d16","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"url":{"type":"string","format":"uri","example":"https://example.com/webhooks/whatsapp","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"status":{"type":"string","description":"Subscription state, for example `active`.","example":"active","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","example":"2026-10-20T09:15:00Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2026-10-20T09:15:00Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"6a1c3e5b-7d9f-4b2a-8c4e-6f8a0b2c4d16","url":"https://example.com/webhooks/whatsapp","status":"active","created_at":"2026-10-20T09:15:00Z","updated_at":"2026-10-20T09:15:00Z"},"examples":{"Example":{"title":"Example","value":{"id":"6a1c3e5b-7d9f-4b2a-8c4e-6f8a0b2c4d16","url":"https://example.com/webhooks/whatsapp","status":"active","created_at":"2026-10-20T09:15:00Z","updated_at":"2026-10-20T09:15:00Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"15ca5433-31af-4849-9672-24da2650f327":{"description":"`url` or `secret` is missing.","content":{"application/json":{"schema":{"type":"object","description":"An error response: a flat object with one `error` string. Use the HTTP status code to decide how to handle the error, and log `error` for diagnosis.","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable explanation of the error. Branch on the HTTP status code rather than on this text.","example":"channel not found","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"url and secret are required"},"examples":{"Example":{"title":"Example","value":{"error":"url and secret are required"}}},"exampleType":"examples"}},"exampleType":"examples"},"884b62a0-ae57-408e-b1af-afd8697be238":{"description":"Missing or invalid `X-Auth-ID` / `X-Auth-Token`.","content":{"application/json":{"schema":{"type":"object","description":"The body of an authentication (`401`) or authorization (`403`) error.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"The HTTP status code, repeated.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","description":"What went wrong.","example":"Invalid authentication credentials","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid":{"title":"invalid","summary":"Invalid credentials","value":{"error":{"code":401,"message":"Invalid authentication credentials"}}},"missing":{"title":"missing","summary":"Missing credentials","value":{"error":{"code":401,"message":"Authentication required: provide either Authorization header or X-Auth-ID and X-Auth-Token headers"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9efb6fc9-69cc-46e7-ae17-4e17eaf9045d":{"description":"The `{auth_id}` in the path is not the account your credentials belong to.","content":{"application/json":{"schema":{"type":"object","description":"The body of an authentication (`401`) or authorization (`403`) error.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"The HTTP status code, repeated.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","description":"What went wrong.","example":"Invalid authentication credentials","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":403,"message":"Access denied: account ID mismatch"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":403,"message":"Access denied: account ID mismatch"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d8ef9c4b-f6c6-4cce-83d2-a8fc5d3da734":{"AuthID":{"type":"apiKey","in":"header","name":"X-Auth-ID","description":"Your Vobiz account Auth ID (`MA_XXXXXXXX`).","scopes":[],"schemeName":"AuthID"},"AuthToken":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"Your Vobiz account Auth Token.","scopes":[],"schemeName":"AuthToken"}}},"servers":{"ca7d3c8e-f917-4390-a962-8336b70e4a60":{"url":"https://api.vobiz.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Auth-ID","description":"Your Vobiz account Auth ID (`MA_XXXXXXXX`).","scopes":[],"schemeName":"AuthID"},"schema":{"title":"X-Auth-ID","type":"string","description":"Your Vobiz account Auth ID (`MA_XXXXXXXX`).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AuthID","name":"X-Auth-ID"},{"scheme":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"Your Vobiz account Auth Token.","scopes":[],"schemeName":"AuthToken"},"schema":{"title":"X-Auth-Token","type":"string","description":"Your Vobiz account Auth Token.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AuthToken","name":"X-Auth-Token"}],"title":"AuthID \u0026 AuthToken"}]},"originalFileLocation":"openapi-whatsapp.yaml"},"subdomain":"vobizai","siteName":"Vobiz","title":"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events - Vobiz","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T21:13:18.410Z","originalFileLocation":"whatsapp/api/webhooks.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=\"dark\"}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=\"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_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=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"WhatsApp Webhooks API — Subscribe to Delivery \u0026amp; Inbound Events - Vobiz\">\u003cmeta data-mint-head property=\"og:description\" content=\"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vobiz Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.vobiz.ai/docs/whatsapp/api/webhooks\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vobizai.mintlify.site/docs/_mintlify/api/og/v2?division=WhatsApp+Business+API\u0026amp;title=WhatsApp+Webhooks+API+%E2%80%94+Subscribe+to+Delivery+%26+Inbound+Events\u0026amp;description=Manage+Vobiz+outbound+webhook+subscriptions+and+the+inbound+Meta+callback+-+receive+WhatsApp+messages%2C+delivery+status%2C+and+call+events+on+your+server.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=8910b165c3abe900d16afcfd13a45a9a1d0e54c2ac9f5d10ceb92d989bbab0e5\">\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=\"WhatsApp Webhooks API — Subscribe to Delivery \u0026amp; Inbound Events - Vobiz\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vobizai.mintlify.site/docs/_mintlify/api/og/v2?division=WhatsApp+Business+API\u0026amp;title=WhatsApp+Webhooks+API+%E2%80%94+Subscribe+to+Delivery+%26+Inbound+Events\u0026amp;description=Manage+Vobiz+outbound+webhook+subscriptions+and+the+inbound+Meta+callback+-+receive+WhatsApp+messages%2C+delivery+status%2C+and+call+events+on+your+server.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=8910b165c3abe900d16afcfd13a45a9a1d0e54c2ac9f5d10ceb92d989bbab0e5\">\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=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E83C00\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@Vobiz_Ai\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#E83C00\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"dark light\">\u003cmeta data-mint-head name=\"author\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"publisher\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"copyright\" content=\"Copyright 2025 Vobiz\">\u003cmeta data-mint-head name=\"reply-to\" content=\"support@vobiz.ai\">\u003cmeta data-mint-head name=\"format-detection\" content=\"telephone=no\">\u003cmeta data-mint-head name=\"referrer\" content=\"origin-when-cross-origin\">\u003cmeta data-mint-head name=\"rating\" content=\"general\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"category\" content=\"Technology\">\u003cmeta data-mint-head name=\"coverage\" content=\"Worldwide\">\u003cmeta data-mint-head name=\"distribution\" content=\"global\">\u003cmeta data-mint-head name=\"target\" content=\"all\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.vobiz.ai/docs/whatsapp/api/webhooks\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/whatsapp/api/webhooks.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.vobiz.ai/#organization\",\"name\":\"Vobiz\",\"url\":\"https://www.vobiz.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/light.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=8e1f6273f626f638f46d6df526d4775c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.vobiz.ai/docs#website\",\"name\":\"Vobiz\",\"url\":\"https://www.vobiz.ai/docs\",\"publisher\":{\"@id\":\"https://www.vobiz.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.vobiz.ai/docs/whatsapp/api/webhooks#webpage\",\"url\":\"https://www.vobiz.ai/docs/whatsapp/api/webhooks\",\"name\":\"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events\",\"description\":\"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.\",\"dateModified\":\"2026-11-18T21:13:18.410Z\",\"isPartOf\":{\"@id\":\"https://www.vobiz.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.vobiz.ai/docs/whatsapp/api/webhooks#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.vobiz.ai/docs/whatsapp/api/webhooks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"WhatsApp Business API\",\"item\":\"https://www.vobiz.ai/docs/whatsapp/api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events\",\"item\":\"https://www.vobiz.ai/docs/whatsapp/api/webhooks\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.vobiz.ai/docs/whatsapp/api/webhooks#apireference\",\"headline\":\"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events\",\"name\":\"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events\",\"description\":\"Manage Vobiz outbound webhook subscriptions and the inbound Meta callback - receive WhatsApp messages, delivery status, and call events on your server.\",\"url\":\"https://www.vobiz.ai/docs/whatsapp/api/webhooks\",\"mainEntityOfPage\":{\"@id\":\"https://www.vobiz.ai/docs/whatsapp/api/webhooks#webpage\"},\"dateModified\":\"2026-11-18T21:13:18.410Z\",\"keywords\":\"WhatsApp webhooks API, Meta webhooks WhatsApp, WhatsApp webhook configuration, WhatsApp event subscriptions, WhatsApp delivery status webhook, WhatsApp inbound message webhook, WhatsApp webhook endpoints, WABA webhook setup, real-time WhatsApp events, WhatsApp webhook payload, WhatsApp Vobiz subscriptions, WhatsApp event forwarding, WhatsApp webhook URL, WhatsApp callback API, WhatsApp webhook security, X-Webhook-Signature, X-Hub-Signature-256, WhatsApp webhook integration, WhatsApp event API India, WhatsApp message status webhook\",\"publisher\":{\"@id\":\"https://www.vobiz.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://www.vobiz.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vobiz\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Vobiz\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/whatsapp/api/webhooks.md","siteName":"Vobiz","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"signal","href":"https://status.vobiz.ai"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","anchors":[{"anchor":"Regular APIs","icon":"database","pages":[{"title":"Regular APIs","href":"/account"}]},{"anchor":"SIP Trunking","icon":"network-wired","pages":[{"title":"SIP Trunking","href":"/trunks"}]},{"anchor":"Voice \u0026 XML","icon":"microphone","pages":[{"title":"Voice \u0026 XML","href":"/applications"}]},{"anchor":"SMS \u0026 RCS","icon":"comment-sms","pages":[{"title":"SMS \u0026 RCS","href":"/sms/overview"}]},{"anchor":"WhatsApp","icon":"comment-dots","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"WhatsApp Business API Introduction — Features \u0026 Coverage","href":"/whatsapp/getting-started/introduction"},{"title":"WhatsApp Business Prerequisites — Meta Account \u0026 Number","href":"/whatsapp/getting-started/prerequisites"},{"title":"WhatsApp Business Quick Start — Send Your First Message","href":"/whatsapp/getting-started/quick-start"},{"title":"WhatsApp Console Walkthrough — Signup, Templates \u0026 Campaigns","sidebarTitle":"Console Walkthrough","href":"/whatsapp/getting-started/console-walkthrough"}]},{"group":"Channel Management","icon":"satellite-dish","root":{"title":"WhatsApp Channel Management — Connect \u0026 Monitor WABA","href":"/whatsapp/channels"},"pages":[{"title":"Bring Your Own Number (BYON) Setup Guide","href":"/whatsapp/channels/byon"}]},{"group":"Messaging","icon":"message","root":{"title":"WhatsApp Messaging — Message Types, 24-Hour Window \u0026 Templates","href":"/whatsapp/messaging"},"pages":[{"title":"Using the WhatsApp Inbox","href":"/whatsapp/messaging/inbox"},{"title":"WhatsApp Message Templates","href":"/whatsapp/messaging/templates"}]},{"group":"Webhooks","icon":"webhook","root":{"title":"WhatsApp Webhooks — Receive Message \u0026 Delivery Events","href":"/whatsapp/webhooks"},"pages":[{"title":"WhatsApp Webhook Events — Inbound, Status \u0026 Call Payloads","href":"/whatsapp/webhooks/events"}]},{"group":"WhatsApp Business API","icon":"code","root":{"title":"Vobiz WhatsApp Business API","sidebarTitle":"WhatsApp API overview","href":"/whatsapp/api"},"pages":[{"title":"WhatsApp API Authentication — X-Auth-ID \u0026 X-Auth-Token Headers","href":"/whatsapp/api/authentication"},{"title":"WhatsApp Send Message API — Text, Media \u0026 Template Messages","openapi":"openapi-whatsapp.yaml POST /api/v1/Account/{auth_id}/WhatsApp/Message/","href":"/whatsapp/api/send-message"},{"title":"WhatsApp Channels API — Connect WABA \u0026 Manage Tokens","openapi":"openapi-whatsapp.yaml GET /api/v1/Account/{auth_id}/WhatsApp/Channel/","href":"/whatsapp/api/channels"},{"title":"WhatsApp Numbers API — Search, Purchase \u0026 BYON Verification","openapi":"openapi-whatsapp.yaml GET /api/v1/Account/{auth_id}/WhatsApp/Number/Availability/","href":"/whatsapp/api/numbers"},{"title":"WhatsApp Conversations API — List \u0026 Paginate Message Threads","openapi":"openapi-whatsapp.yaml GET /api/v1/Account/{auth_id}/WhatsApp/Conversation/","href":"/whatsapp/api/conversations"},{"title":"WhatsApp Contacts API — Create, Tag \u0026 Bulk Import via CSV","openapi":"openapi-whatsapp.yaml GET /api/v1/Account/{auth_id}/WhatsApp/Contact/","href":"/whatsapp/api/contacts"},{"title":"WhatsApp Templates API — Submit \u0026 Manage Templates","openapi":"openapi-whatsapp.yaml GET /api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/","href":"/whatsapp/api/templates"},{"title":"WhatsApp Campaigns API — Bulk Template Broadcasts","openapi":"openapi-whatsapp.yaml POST /api/v1/Account/{auth_id}/WhatsApp/Campaign/","href":"/whatsapp/api/campaigns"},{"title":"WhatsApp Canned Responses API — Reply Shortcuts","openapi":"openapi-whatsapp.yaml GET /api/v1/Account/{auth_id}/WhatsApp/CannedResponse/","href":"/whatsapp/api/canned-responses"},{"title":"WhatsApp Calls API — Initiate \u0026 Manage Business Voice Calls","description":"Initiate and manage WhatsApp Business voice calls through Vobiz - WebRTC-based signaling for inbound, outbound, and call state management.","openapi":"openapi-whatsapp.yaml POST /api/v1/Account/{auth_id}/WhatsApp/Call/","href":"/whatsapp/api/calls"},{"title":"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events","openapi":"openapi-whatsapp.yaml POST /api/v1/Account/{auth_id}/WhatsApp/Webhook/","href":"/whatsapp/api/webhooks"}]}]},{"anchor":"Partner API","icon":"handshake","pages":[{"title":"Partner API","href":"/partner"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"Examples \u0026 Tutorials","pages":[{"title":"Examples \u0026 Tutorials","href":"/guides/ai-voice-agent"}]},{"tab":"Blogs","pages":[{"title":"Blogs","href":"/blogs"}]}]},"basePath":"","title":"WhatsApp Webhooks API — Subscribe to Delivery \u0026 Inbound Events - Vobiz","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","Page--B9YZ09u.js","CodeSnippet-CTZvgJfu.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","getApiPlaygroundDisplay-BK2o1XYu.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}