X-Wachat-Signature is an HMAC-SHA256 signature of:
timestamp.raw_json_body
using your webhook secret.
The webhook URL must use HTTPS. The secret is returned when creating/updating a webhook. Store it securely.
Authorizations
Authorization
string
header
required
Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.
Body
application/json
url
string
required
HTTPS endpoint that will receive Wachat webhook deliveries.
Example:
"https://example.com/wachat/webhook"
id
integer
Existing webhook id. Include this to update a webhook.
Example:
12
name
string
Example:
"Production webhook"
events
enum<string>[]
Available options:
*,
messages.upsert,
messages.update,
contacts.update,
chats.update,
qrcode.updated,
connection.update
Example:
["messages.upsert", "connection.update"]
instanceName
string
Optional API instance name. Omit this to receive events for all instances in the account.
Example:
"t1_mq9r2jov_jakarta_store"
enabled
boolean
default:true
Example:
true
secret
string
Optional custom webhook secret. If omitted, Wachat generates one.
Example:
"whsec_your_custom_secret"
Response
Webhook updated successfully.
success
boolean
Example:
true
webhook
object
Show child attributes
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Wachat","colors":{"primary":"#25D366","light":"#4ade80","dark":"#16a34a"},"favicon":"https://mintcdn.com/wachat-336ab83a/9nBhxtXyAAg2y0Gz/logo/favicon.png?fit=max\u0026auto=format\u0026n=9nBhxtXyAAg2y0Gz\u0026q=85\u0026s=afe15ff563e4f1b3b27f860d807640c6","logo":{"light":"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58","dark":"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58"},"api":{"openapi":"https://crm.wachat.net/docs/api.json","playground":{"display":"interactive"},"mdx":{"server":"https://crm.wachat.net/api/v1","auth":{"method":"bearer","name":null}}},"navbar":{"links":[{"label":"Pricing","href":"https://www.wachat.net/pricing"},{"label":"Support","href":"mailto:support@wachat.net"}],"primary":{"type":"button","label":"Dashboard","href":"https://crm.wachat.net"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wachat-336ab83a","hasAudioNarration":false,"actualSubdomain":"wachat-336ab83a","customDomains":["docs.wachat.net"],"gitSource":{"type":"github","owner":"whmcs90","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ab8da941f8fe965b40df0a2","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Messages","count":9},{"language":"default","tag":"Instances","count":7},{"language":"default","tag":"Webhooks","count":3},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Start here","count":2},{"language":"default","tag":"Account","count":1},{"language":"default","tag":"Numbers","count":1},{"language":"default","tag":"Contacts","count":1},{"language":"default","tag":"Groups","count":1},{"language":"default","tag":"API Reference","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/webhooks-create","slug":"/api-reference/webhooks-create","pageMetadata":{"title":"Create Webhook","openapi":"POST /webhooks","description":null,"href":"/api-reference/webhooks-create"},"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={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Create a webhook endpoint for your Wachat account.`}),`\n`,_jsxs(_components.p,{children:[`Webhooks can listen to all instances or only one specific `,_jsx(_components.code,{children:`apiInstanceName`}),`.`]}),`\n`,_jsx(_components.p,{children:`Supported events:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,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:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`*`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`messages.upsert`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`messages.update`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`contacts.update`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`chats.update`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`qrcode.updated`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`connection.update`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`10`,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:`10`,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:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://crm.wachat.net/api/v1/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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer 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:` -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:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"Production webhook\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"url\": \"https://example.com/wachat/webhook\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"instanceName\": \"t1_mq9r2jov_jakarta_store\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"events\": [\"messages.upsert\", \"connection.update\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"enabled\": true`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`To receive events from all instances, omit `,_jsx(_components.code,{children:`instanceName`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`delivery-headers`,children:`Delivery Headers`}),`\n`,_jsx(_components.p,{children:`Every webhook delivery includes these headers:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`X-Wachat-Event`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`X-Wachat-Timestamp`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`X-Wachat-Signature`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`X-Wachat-Webhook-Id`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`X-Wachat-Signature`}),` is an HMAC-SHA256 signature of:`]}),`\n`,_jsx(CodeBlock,{filename:``,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:`timestamp.raw_json_body`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`using your webhook secret.`}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The webhook URL must use HTTPS. The secret is returned when creating/updating a webhook. Store it securely.`})})]})}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","openapi":"POST /webhooks","description":null,"href":"/api-reference/webhooks-create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Delivery Headers","slug":"delivery-headers","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create or Update Webhook","description":"Create a new webhook endpoint, or update an existing webhook by passing its id.","tags":["Webhooks"],"requestBody":"e97d98e3-6e3c-4e68-98ba-0cb0624428d3","responses":{"200":"884d6bb2-cf00-48ef-a0d7-8732137001f2","201":"7c14b196-7e8d-4f0e-8d4b-013be68e4eae","400":"c673200c-362a-440f-970b-f5e6488e04a0","401":"3c1b4409-5461-4045-96fe-e58882741934","403":"afcaa2b3-05dc-47e7-87e5-657a16bcff7d","404":"5dbd0306-614d-47ef-98ed-d05c014a9489"},"method":"post","type":"path","servers":["536c3b0c-abef-4d8d-8483-52ee9fa5eda9"],"security":["8dd0d32d-495e-4c03-bbd7-8622d71ed8f9"],"path":"/webhooks","baseUrlOptions":["https://crm.wachat.net/api/v1"],"title":"Create or Update Webhook","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"HTTPS endpoint that will receive Wachat webhook deliveries.","example":"https://example.com/wachat/webhook","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"id":{"type":"integer","description":"Existing webhook id. Include this to update a webhook.","example":12,"uniqueKey":"id","typeLabel":"integer"},"name":{"type":"string","example":"Production webhook","uniqueKey":"name","typeLabel":"string"},"events":{"type":"array","items":{"type":"string","enum":["*","messages.upsert","messages.update","contacts.update","chats.update","qrcode.updated","connection.update"],"uniqueKey":"events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["messages.upsert","connection.update"],"uniqueKey":"events","typeLabel":"enum\u003cstring>[]"},"instanceName":{"type":"string","description":"Optional API instance name. Omit this to receive events for all instances in the account.","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"instanceName","typeLabel":"string"},"enabled":{"type":"boolean","default":true,"example":true,"uniqueKey":"enabled","typeLabel":"boolean"},"secret":{"type":"string","description":"Optional custom webhook secret. If omitted, Wachat generates one.","example":"whsec_your_custom_secret","uniqueKey":"secret","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"url":"https://example.com/wachat/webhook","id":12,"name":"Production webhook","events":["messages.upsert","connection.update"],"instanceName":"t1_mq9r2jov_jakarta_store","enabled":true,"secret":"whsec_your_custom_secret"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"884d6bb2-cf00-48ef-a0d7-8732137001f2":{"description":"Webhook updated successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"webhook":{"type":"object","properties":{"id":{"type":"integer","example":12,"uniqueKey":"webhook.id","typeLabel":"integer"},"name":{"oneOf":[{"type":"string","example":"Production webhook","uniqueKey":"webhook.name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Production webhook","uniqueKey":"webhook.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook.name","typeLabel":"string | null"},"url":{"type":"string","example":"https://example.com/wachat/webhook","uniqueKey":"webhook.url","typeLabel":"string"},"events":{"type":"array","items":{"type":"string","uniqueKey":"webhook.events.items.[INDEX]","typeLabel":"string"},"example":["messages.upsert","connection.update"],"uniqueKey":"webhook.events","typeLabel":"string[]"},"enabled":{"type":"boolean","example":true,"uniqueKey":"webhook.enabled","typeLabel":"boolean"},"secret":{"type":"string","description":"Masked in list responses. Returned in full when creating or updating a webhook.","example":"whsec_••••abcdef","uniqueKey":"webhook.secret","typeLabel":"string"},"instance":{"oneOf":[{"type":"object","properties":{"instanceName":{"type":"string","example":"jakarta_store","uniqueKey":"webhook.instance.oneOf.0.instanceName","typeLabel":"string"},"displayName":{"type":"string","example":"jakarta_store","uniqueKey":"webhook.instance.oneOf.0.displayName","typeLabel":"string"},"apiInstanceName":{"type":"string","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"webhook.instance.oneOf.0.apiInstanceName","typeLabel":"string"},"internalName":{"type":"string","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"webhook.instance.oneOf.0.internalName","typeLabel":"string"}},"uniqueKey":"webhook.instance.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"instanceName":{"type":"string","example":"jakarta_store"},"displayName":{"type":"string","example":"jakarta_store"},"apiInstanceName":{"type":"string","example":"t1_mq9r2jov_jakarta_store"},"internalName":{"type":"string","example":"t1_mq9r2jov_jakarta_store"}},"uniqueKey":"webhook.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook.instance","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","example":"2026-06-13T08:00:00.000Z","uniqueKey":"webhook.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","example":"2026-06-13T08:00:00.000Z","uniqueKey":"webhook.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"webhook","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"webhook":{"id":12,"name":"Production webhook","url":"https://example.com/wachat/webhook","events":["messages.upsert","connection.update"],"enabled":true,"secret":"whsec_••••abcdef","instance":{"instanceName":"jakarta_store","displayName":"jakarta_store","apiInstanceName":"t1_mq9r2jov_jakarta_store","internalName":"t1_mq9r2jov_jakarta_store"},"createdAt":"2026-06-13T08:00:00.000Z","updatedAt":"2026-06-13T08:00:00.000Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7c14b196-7e8d-4f0e-8d4b-013be68e4eae":{"description":"Webhook created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"webhook":{"type":"object","properties":{"id":{"type":"integer","example":12,"uniqueKey":"webhook.id","typeLabel":"integer"},"name":{"oneOf":[{"type":"string","example":"Production webhook","uniqueKey":"webhook.name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Production webhook","uniqueKey":"webhook.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook.name","typeLabel":"string | null"},"url":{"type":"string","example":"https://example.com/wachat/webhook","uniqueKey":"webhook.url","typeLabel":"string"},"events":{"type":"array","items":{"type":"string","uniqueKey":"webhook.events.items.[INDEX]","typeLabel":"string"},"example":["messages.upsert","connection.update"],"uniqueKey":"webhook.events","typeLabel":"string[]"},"enabled":{"type":"boolean","example":true,"uniqueKey":"webhook.enabled","typeLabel":"boolean"},"secret":{"type":"string","description":"Masked in list responses. Returned in full when creating or updating a webhook.","example":"whsec_••••abcdef","uniqueKey":"webhook.secret","typeLabel":"string"},"instance":{"oneOf":[{"type":"object","properties":{"instanceName":{"type":"string","example":"jakarta_store","uniqueKey":"webhook.instance.oneOf.0.instanceName","typeLabel":"string"},"displayName":{"type":"string","example":"jakarta_store","uniqueKey":"webhook.instance.oneOf.0.displayName","typeLabel":"string"},"apiInstanceName":{"type":"string","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"webhook.instance.oneOf.0.apiInstanceName","typeLabel":"string"},"internalName":{"type":"string","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"webhook.instance.oneOf.0.internalName","typeLabel":"string"}},"uniqueKey":"webhook.instance.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"instanceName":{"type":"string","example":"jakarta_store"},"displayName":{"type":"string","example":"jakarta_store"},"apiInstanceName":{"type":"string","example":"t1_mq9r2jov_jakarta_store"},"internalName":{"type":"string","example":"t1_mq9r2jov_jakarta_store"}},"uniqueKey":"webhook.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook.instance","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","example":"2026-06-13T08:00:00.000Z","uniqueKey":"webhook.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","example":"2026-06-13T08:00:00.000Z","uniqueKey":"webhook.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"webhook","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"webhook":{"id":12,"name":"Production webhook","url":"https://example.com/wachat/webhook","events":["messages.upsert","connection.update"],"enabled":true,"secret":"whsec_••••abcdef","instance":{"instanceName":"jakarta_store","displayName":"jakarta_store","apiInstanceName":"t1_mq9r2jov_jakarta_store","internalName":"t1_mq9r2jov_jakarta_store"},"createdAt":"2026-06-13T08:00:00.000Z","updatedAt":"2026-06-13T08:00:00.000Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c673200c-362a-440f-970b-f5e6488e04a0":{"description":"Invalid payload, unsupported event, or non-HTTPS URL.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"3c1b4409-5461-4045-96fe-e58882741934":{"description":"Missing or invalid API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"afcaa2b3-05dc-47e7-87e5-657a16bcff7d":{"description":"Subscription restriction prevented webhook creation.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"5dbd0306-614d-47ef-98ed-d05c014a9489":{"description":"Instance or webhook not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"8dd0d32d-495e-4c03-bbd7-8622d71ed8f9":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","scopes":[]}}},"servers":{"536c3b0c-abef-4d8d-8483-52ee9fa5eda9":{"url":"https://crm.wachat.net/api/v1","description":"Live Production Gateway"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"wachat-336ab83a","siteName":"Wachat","title":"Create Webhook - Wachat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-27T08:58:04.462Z","originalFileLocation":"api-reference/webhooks-create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Wachat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Webhook - Wachat\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wachat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wachat.net/api-reference/webhooks-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wachat-336ab83a.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+Webhook\u0026amp;theme=67933629576128fde9291cfd\u0026amp;signature=b734351d52a94192e11bbffb29abd93a19ca4da287b77e2cdc9229646513d316\">\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 - Wachat\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wachat-336ab83a.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+Webhook\u0026amp;theme=67933629576128fde9291cfd\u0026amp;signature=b734351d52a94192e11bbffb29abd93a19ca4da287b77e2cdc9229646513d316\">\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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wachat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#25D366\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wachat.net/api-reference/webhooks-create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks-create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wachat.net/#organization\",\"name\":\"Wachat\",\"url\":\"https://docs.wachat.net\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wachat.net#website\",\"name\":\"Wachat\",\"url\":\"https://docs.wachat.net\",\"publisher\":{\"@id\":\"https://docs.wachat.net/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wachat.net/api-reference/webhooks-create#webpage\",\"url\":\"https://docs.wachat.net/api-reference/webhooks-create\",\"name\":\"Create Webhook\",\"dateModified\":\"2026-09-27T08:58:04.462Z\",\"isPartOf\":{\"@id\":\"https://docs.wachat.net#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wachat.net/api-reference/webhooks-create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wachat.net/api-reference/webhooks-create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.wachat.net/api-reference/webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Webhook\",\"item\":\"https://docs.wachat.net/api-reference/webhooks-create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wachat.net/api-reference/webhooks-create#apireference\",\"headline\":\"Create Webhook\",\"name\":\"Create Webhook\",\"url\":\"https://docs.wachat.net/api-reference/webhooks-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wachat.net/api-reference/webhooks-create#webpage\"},\"dateModified\":\"2026-09-27T08:58:04.462Z\",\"publisher\":{\"@id\":\"https://docs.wachat.net/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wachat.net#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wachat\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Wachat\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/webhooks-create.md","siteName":"Wachat","nav":{"global":null,"groups":[{"group":"Start here","pages":[{"title":"Build on Wachat","mode":"wide","href":"/index"},{"title":"Introduction","href":"/introduction"}]},{"group":"Guides","pages":[{"title":"Authentication","href":"/guides/authentication"},{"title":"Quickstart","href":"/guides/quickstart"},{"title":"Webhooks","href":"/guides/webhooks"}]},{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Account","pages":[{"title":"Get Account Limits","openapi":"GET /account/limits","href":"/api-reference/account-limits"}]},{"group":"Messages","pages":[{"title":"Send Text Message","openapi":"POST /send/text","href":"/api-reference/send-text"},{"title":"Send Media Message","openapi":"POST /send/media","href":"/api-reference/send-media"},{"title":"Send Reply Buttons","openapi":"openapi.yaml POST /send/button","href":"/api-reference/send-button"},{"title":"Send Carousel","openapi":"POST /send/carousel","href":"/api-reference/send-carousel"},{"title":"Send CTA Buttons","openapi":"POST /send/cta","href":"/api-reference/send-cta"},{"title":"Send List Menu","openapi":"POST /send/list","href":"/api-reference/send-list"},{"title":"Send Group Message","openapi":"POST /send-group","href":"/api-reference/send-group"},{"title":"Send Location","openapi":"POST /send-location","href":"/api-reference/send-location"},{"title":"Send Poll","openapi":"POST /send-poll","href":"/api-reference/send-poll"}]},{"group":"Instances","pages":[{"title":"Create Instance","openapi":"POST /instance/create","href":"/api-reference/instance-create"},{"title":"Get QR Image","openapi":"GET /instance/qr/image","href":"/api-reference/instance-qr-image"},{"title":"Get Instance State","openapi":"GET /instance/state","href":"/api-reference/instance-state"},{"title":"Get Profile Picture","openapi":"GET /instance/profile-picture","href":"/api-reference/instance-profile-picture"},{"title":"List Instances","openapi":"GET /instance/list","href":"/api-reference/instance-list"},{"title":"Logout Instance","openapi":"DELETE /instance/logout","href":"/api-reference/instance-logout"},{"title":"Delete Instance","openapi":"DELETE /instance/delete","href":"/api-reference/instance-delete"}]},{"group":"Groups","pages":[{"title":"Get All Groups","openapi":"GET /groups","href":"/api-reference/groups"}]},{"group":"Contacts","pages":[{"title":"List Contacts","openapi":"GET /contacts","href":"/api-reference/contacts"}]},{"group":"Numbers","pages":[{"title":"Check Number","openapi":"GET /check-number","href":"/api-reference/check-number"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","openapi":"GET /webhooks","description":null,"href":"/api-reference/webhooks"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/webhooks-create"},{"title":"Delete Webhook","openapi":"DELETE /webhooks","description":null,"href":"/api-reference/webhooks-delete"}]}]},"basePath":"","title":"Create Webhook - Wachat","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}