{
"success": false,
"error": {
"messageKey": "too_many_requests",
"message": "Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."
}
}
{
"success": false,
"error": {
"messageKey": "too_many_requests",
"message": "Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."
}
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Heyy Help Center","colors":{"primary":"#FE3265","light":"#FE3265","dark":"#FE3265"},"logo":{"light":"https://mintcdn.com/heyy-c8bd5c9e/cOuWPkt81GyZiNr6/assets/logo.svg?fit=max\u0026auto=format\u0026n=cOuWPkt81GyZiNr6\u0026q=85\u0026s=15d8f051f3dbe3cb5e5d0241b7a50372","dark":"https://mintcdn.com/heyy-c8bd5c9e/cOuWPkt81GyZiNr6/assets/logo.svg?fit=max\u0026auto=format\u0026n=cOuWPkt81GyZiNr6\u0026q=85\u0026s=15d8f051f3dbe3cb5e5d0241b7a50372","href":"https://app.heyy.io"},"favicon":"https://mintcdn.com/heyy-c8bd5c9e/yDd_iArPMYbdrfO5/favicon.svg?fit=max\u0026auto=format\u0026n=yDd_iArPMYbdrfO5\u0026q=85\u0026s=c04875889f1d50bf2447289aa0b31f4f","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://wa.me/16504570123","label":"Contact support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.heyy.io"}},"footer":{"socials":{"instagram":"https://www.instagram.com/heyy_hq","linkedin":"https://www.linkedin.com/company/heyyio","x":"https://x.com/Heyy_hq","website":"https://app.heyy.io"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Satoshi","weight":700,"source":"fonts/Satoshi-Variable.woff2","format":"woff2"}},"icons":{"library":"lucide"},"integrations":{"telemetry":{"enabled":true}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heyy-c8bd5c9e","hasAudioNarration":false,"actualSubdomain":"heyy-c8bd5c9e","customDomains":["docs.heyy.io"],"gitSource":{"type":"github","owner":"heyy-io","repo":"heyy-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac63f1943f8b0b9e9831153","collectionId":"42fb144c-e7fc-4b9a-8074-ef745a9f2295","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac63f1943f8b0b9e9831153"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ac63f1943f8b0b9e9831153","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Help Center","count":124},{"language":"default","tag":"API Reference","count":115},{"language":"default","tag":"HEYY API","count":101},{"language":"default","tag":"AI EMPLOYEES","count":33},{"language":"default","tag":"AUTOMATIONS","count":32},{"language":"default","tag":"Chat","count":20},{"language":"default","tag":"MANAGING YOUR INBOX","count":18},{"language":"default","tag":"Contact","count":18},{"language":"default","tag":"MESSAGING CHANNELS","count":17},{"language":"default","tag":"Triggers","count":15}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".changelog-month-header{position:relative;padding-block:40px}.changelog-month-bg{position:absolute;top:0;left:50%;width:100vw;height:100%;transform:translateX(-50%);margin-inline:0;z-index:1;background-color:rgb(var(--gray-50)/.5);mask-image:linear-gradient(0deg,#fff,rgba(255,255,255,.6));background-image:url(\"data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32' width='32' height='32' fill='none' stroke='rgb(229 229 229 / 0.2)'%3e%3cpath d='M0 .5H31.5V32'/%3e%3c/svg%3e\");border-top:1px solid rgb(0 0 0/.05);border-bottom:1px solid rgb(0 0 0/.05)}.dark .changelog-month-bg{background-color:rgb(var(--gray-800)/.25);mask-image:linear-gradient(0deg,rgba(255,255,255,.3),rgba(255,255,255,.8));background-image:url(\"data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32' width='32' height='32' fill='none' stroke='rgb(255 255 255 / 0.05)'%3e%3cpath d='M0 .5H31.5V32'/%3e%3c/svg%3e\");border-top:1px solid rgb(255 255 255/.05);border-bottom:1px solid rgb(255 255 255/.05)}.changelog-month-content{position:relative;z-index:2}.changelog-month-kicker{font-size:11px;letter-spacing:.14em;text-transform:uppercase;opacity:.6;margin-bottom:8px;font-weight:500}"}],"page":{"pagePath":"api-reference/search-api-webhooks","slug":"/api-reference/search-api-webhooks","pageMetadata":{"title":"Search API webhooks","description":"Search API webhooks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /api_webhooks/search","href":"/api-reference/search-api-webhooks","autogeneratedByOpenApi":true},"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: \"Search API webhooks.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Search API webhooks","description":"Search API webhooks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /api_webhooks/search","href":"/api-reference/search-api-webhooks","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Search API webhooks","requestBody":"731793a9-6da9-4a3c-bc81-1af9e04ff195","responses":{"200":"6a77bc68-5321-46a9-a736-dca7f709ec08","400":"cc647aab-1816-417f-b0b3-4340e64454c4","401":"d404df4c-74a0-4edc-9d90-b02689967557","402":"ac6f4efd-ebf9-49cc-b1bd-7a12e437eb37","403":"64562745-ad9a-4721-9cae-c57f9d0b5af2","404":"2a03bc2a-22d7-43da-9377-154ef3de72b2","429":"136d19fe-38a3-4cfb-937f-11928473b388","500":"7216eaff-8479-4770-9fc0-b95d63df19a8"},"description":"Search API webhooks.","method":"post","type":"path","servers":["d337f328-cc33-443a-9da2-88c1ad7823c9"],"security":["b75e6a32-453a-4290-9bd4-2a3bb76b1db7"],"path":"/api_webhooks/search","baseUrlOptions":["https://api.heyy.io/v3"],"title":"Search API webhooks","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"Structured filter expression. See [Query syntax](/api-reference/v3/query) for expression functions. Filterable fields: `id`, `createdAt`, `updatedAt`, `status`, `url`, `events`.","uniqueKey":"query","typeLabel":"string"},"sortBy":{"type":"string","description":"Sort expression. See [Sort By syntax](/api-reference/v3/sort-by) for expression functions. Sortable fields: `id`, `createdAt`, `updatedAt`, `status`, `url`, `events`.","uniqueKey":"sortBy","typeLabel":"string"},"search":{"type":"string","description":"Free-text search by `url`. See [Search](/api-reference/v3/search).","uniqueKey":"search","typeLabel":"string"},"pagination":{"type":"object","properties":{"page":{"type":"integer","minimum":0,"description":"Zero-based page index. Defaults to 0 when omitted.","isRequired":true,"uniqueKey":"pagination.page","typeLabel":"integer"},"limit":{"type":"integer","minimum":1,"maximum":100,"description":"Rows per page. Defaults to 10 when omitted. Maximum 100.","isRequired":true,"uniqueKey":"pagination.limit","typeLabel":"integer"}},"required":["page","limit"],"additionalProperties":false,"description":"Page through results. Defaults to page 0 and limit 10 when omitted. See [Pagination](/api-reference/v3/pagination).","uniqueKey":"pagination","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"query":"\u003cstring>","sortBy":"\u003cstring>","search":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6a77bc68-5321-46a9-a736-dca7f709ec08":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].url","typeLabel":"string"},"status":{"type":"string","enum":["active","inactive"],"isRequired":true,"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"events":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["whatsapp_message_received","whatsapp_message_status","message.received","message.sent","message.updated"],"isRequired":true,"uniqueKey":"data.items.[INDEX].events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"scopes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["channel"],"isRequired":true,"uniqueKey":"data.items.[INDEX].events.items.[INDEX].scopes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].events.items.[INDEX].scopes.items.[INDEX].ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.items.[INDEX].events.items.[INDEX].scopes.items.[INDEX].ids","typeLabel":"string[]"}},"required":["type","ids"],"uniqueKey":"data.items.[INDEX].events.items.[INDEX].scopes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].events.items.[INDEX].scopes","typeLabel":"object[]"}},"required":["type","scopes"],"uniqueKey":"data.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].events","typeLabel":"object[]"},"id":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["url","status","events","id","createdAt","updatedAt"],"additionalProperties":false,"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"pagination":{"type":"object","properties":{"page":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"pagination.page","typeLabel":"integer"},"limit":{"type":"integer","maximum":1000,"isRequired":true,"uniqueKey":"pagination.limit","typeLabel":"integer"},"total":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"pagination.total","typeLabel":"integer"}},"required":["page","limit","total"],"additionalProperties":false,"isRequired":true,"uniqueKey":"pagination","typeLabel":"object"},"query":{"type":"object","properties":{"query":{"type":"string","uniqueKey":"query.query","typeLabel":"string"},"sortBy":{"type":"string","uniqueKey":"query.sortBy","typeLabel":"string"},"search":{"type":"string","uniqueKey":"query.search","typeLabel":"string"}},"isRequired":true,"uniqueKey":"query","typeLabel":"object"},"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"}},"required":["data","pagination","query","success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"url":"\u003cstring>","status":"active","events":[{"type":"whatsapp_message_received","scopes":[{"type":"channel","ids":["\u003cstring>"]}]}],"id":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}],"pagination":{"page":1,"limit":123,"total":1},"query":{"query":"\u003cstring>","sortBy":"\u003cstring>","search":"\u003cstring>"},"success":true}}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"},"cc647aab-1816-417f-b0b3-4340e64454c4":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"invalid_body_params","message":"Invalid body params","invalidParams":{"email":{"key":"invalid_string","message":"Invalid email"}}}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"invalid_body_params","message":"Invalid body params","invalidParams":{"email":{"key":"invalid_string","message":"Invalid email"}}}}}},"exampleType":"examples"}},"description":"Bad request.","exampleType":"examples"},"d404df4c-74a0-4edc-9d90-b02689967557":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"unauthorized","message":"Unauthorized"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"unauthorized","message":"Unauthorized"}}}},"exampleType":"examples"}},"description":"Unauthorized.","exampleType":"examples"},"ac6f4efd-ebf9-49cc-b1bd-7a12e437eb37":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"insufficient_billing_plan","message":"Insufficient billing plan"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"insufficient_billing_plan","message":"Insufficient billing plan"}}}},"exampleType":"examples"}},"description":"Payment required.","exampleType":"examples"},"64562745-ad9a-4721-9cae-c57f9d0b5af2":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"forbidden","message":"Forbidden"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"forbidden","message":"Forbidden"}}}},"exampleType":"examples"}},"description":"Forbidden.","exampleType":"examples"},"2a03bc2a-22d7-43da-9377-154ef3de72b2":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"contact_not_found","message":"Contact not found"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"contact_not_found","message":"Contact not found"}}}},"exampleType":"examples"}},"description":"Not found.","exampleType":"examples"},"136d19fe-38a3-4cfb-937f-11928473b388":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"too_many_requests","message":"Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"too_many_requests","message":"Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."}}}},"exampleType":"examples"}},"description":"Too many requests.","exampleType":"examples"},"7216eaff-8479-4770-9fc0-b95d63df19a8":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"internal_error","message":"Oops! Something went wrong"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"internal_error","message":"Oops! Something went wrong"}}}},"exampleType":"examples"}},"description":"Internal server error.","exampleType":"examples"}},"security":{"b75e6a32-453a-4290-9bd4-2a3bb76b1db7":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d337f328-cc33-443a-9da2-88c1ad7823c9":{"url":"https://api.heyy.io/v3"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-v3.json"},"subdomain":"heyy-c8bd5c9e","siteName":"Heyy Help Center","title":"Search API webhooks - Heyy Help Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T12:46:29.363Z","originalFileLocation":"api-reference/search-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=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Search API webhooks.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heyy Help Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search API webhooks - Heyy Help Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search API webhooks.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heyy Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heyy.io/api-reference/search-api-webhooks\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://heyy-c8bd5c9e.mintlify.app/_mintlify/api/og/v2?division=MANAGE+WEBHOOKS\u0026amp;title=Search+API+webhooks\u0026amp;description=Search+API+webhooks.\u0026amp;theme=ef3232fe885046deda1ba629\u0026amp;signature=02ea6ea33d97c098bb0f5f43b809656a8a094fcf503299dd5ac4b00d5abcc7ca\">\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=\"Search API webhooks - Heyy Help Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search API webhooks.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://heyy-c8bd5c9e.mintlify.app/_mintlify/api/og/v2?division=MANAGE+WEBHOOKS\u0026amp;title=Search+API+webhooks\u0026amp;description=Search+API+webhooks.\u0026amp;theme=ef3232fe885046deda1ba629\u0026amp;signature=02ea6ea33d97c098bb0f5f43b809656a8a094fcf503299dd5ac4b00d5abcc7ca\">\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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heyy Help Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FE3265\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heyy.io/api-reference/search-api-webhooks\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/search-api-webhooks.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.heyy.io/#organization\",\"name\":\"Heyy Help Center\",\"url\":\"https://docs.heyy.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/heyy-c8bd5c9e/cOuWPkt81GyZiNr6/assets/logo.svg?fit=max\u0026auto=format\u0026n=cOuWPkt81GyZiNr6\u0026q=85\u0026s=15d8f051f3dbe3cb5e5d0241b7a50372\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heyy.io#website\",\"name\":\"Heyy Help Center\",\"url\":\"https://docs.heyy.io\",\"publisher\":{\"@id\":\"https://docs.heyy.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heyy.io/api-reference/search-api-webhooks#webpage\",\"url\":\"https://docs.heyy.io/api-reference/search-api-webhooks\",\"name\":\"Search API webhooks\",\"description\":\"Search API webhooks.\",\"dateModified\":\"2026-10-07T12:46:29.363Z\",\"isPartOf\":{\"@id\":\"https://docs.heyy.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heyy.io/api-reference/search-api-webhooks#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heyy.io/api-reference/search-api-webhooks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"MANAGE WEBHOOKS\",\"item\":\"https://docs.heyy.io/api-reference/create-api-webhook\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search API webhooks\",\"item\":\"https://docs.heyy.io/api-reference/search-api-webhooks\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.heyy.io/api-reference/search-api-webhooks#apireference\",\"headline\":\"Search API webhooks\",\"name\":\"Search API webhooks\",\"description\":\"Search API webhooks.\",\"url\":\"https://docs.heyy.io/api-reference/search-api-webhooks\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heyy.io/api-reference/search-api-webhooks#webpage\"},\"dateModified\":\"2026-10-07T12:46:29.363Z\",\"publisher\":{\"@id\":\"https://docs.heyy.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heyy.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heyy Help Center\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Heyy Help Center","nav":{"global":null,"tabs":[{"tab":"Help Center","icon":"life-buoy","pages":[{"title":"Help Center","href":"/help"}]},{"tab":"API Reference","icon":"code","versions":[{"version":"Version 3","tag":"Latest","groups":[{"group":"GETTING STARTED","pages":[{"title":"Heyy API Documentation - REST API Reference \u0026 Guides","sidebarTitle":"Overview","href":"/api-reference/v3/overview"},{"title":"Authentication","href":"/api-reference/v3/authentication"},{"title":"Versioning","href":"/api-reference/v3/versioning"},{"title":"Query","href":"/api-reference/v3/query"},{"title":"Sort By","href":"/api-reference/v3/sort-by"},{"title":"Search","href":"/api-reference/v3/search"},{"title":"Pagination","href":"/api-reference/v3/pagination"},{"title":"Rate Limiting","href":"/api-reference/v3/rate-limiting"},{"title":"Error Handling","href":"/api-reference/v3/error-handling"}]},{"group":"HEYY API","pages":[{"group":"Attribute","expanded":false,"pages":[{"title":"Search attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /attributes/search","href":"/api-reference/search-attributes"},{"title":"Create attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /attributes","href":"/api-reference/create-attribute"},{"title":"Update attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /attributes/{attributeId}","href":"/api-reference/update-attribute"},{"title":"Get attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /attributes/{attributeId}","href":"/api-reference/get-attribute"},{"title":"Delete attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /attributes/{attributeId}","href":"/api-reference/delete-attribute"}]},{"group":"Automation","expanded":false,"pages":[{"title":"Search automations","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /automations/search","href":"/api-reference/search-automations"},{"title":"Get automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /automations/{automationId}","href":"/api-reference/get-automation"},{"title":"Pause automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /automations/{automationId}/pause","href":"/api-reference/pause-automation"},{"title":"Unpause automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /automations/{automationId}/unpause","href":"/api-reference/unpause-automation"},{"title":"Trigger automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /automations/{automationId}/trigger","href":"/api-reference/trigger-automation"}]},{"group":"Campaign","expanded":false,"pages":[{"title":"Search campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /campaigns/search","href":"/api-reference/search-campaigns"},{"title":"Create campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /campaigns","href":"/api-reference/create-campaign"},{"title":"Update campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /campaigns/{campaignId}","href":"/api-reference/update-campaign"},{"title":"Get campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /campaigns/{campaignId}","href":"/api-reference/get-campaign"},{"title":"Delete campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /campaigns/{campaignId}","href":"/api-reference/delete-campaign"},{"title":"Add recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /campaigns/{campaignId}/recipients","href":"/api-reference/add-recipients"},{"title":"Remove recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /campaigns/{campaignId}/recipients","href":"/api-reference/remove-recipients"},{"title":"Start campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /campaigns/{campaignId}/start","href":"/api-reference/start-campaign"}]},{"group":"Channel","expanded":false,"pages":[{"title":"Search channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /channels/search","href":"/api-reference/search-channels"},{"title":"Get channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /channels/{channelId}","href":"/api-reference/get-channel"}]},{"group":"Chat","expanded":false,"pages":[{"title":"Search chats","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/search","href":"/api-reference/search-chats"},{"title":"Get chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /chats/{chatId}","href":"/api-reference/get-chat"},{"title":"Delete chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /chats/{chatId}","href":"/api-reference/delete-chat"},{"title":"Change chat status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/status","href":"/api-reference/change-chat-status"},{"title":"Assign chat to team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/assign_team","href":"/api-reference/assign-chat-to-team"},{"title":"Assign chat to user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/assign_user","href":"/api-reference/assign-chat-to-user"},{"title":"Mark chat as sensitive","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/mark_as_sensitive","href":"/api-reference/mark-chat-as-sensitive"},{"title":"Mark chat as not sensitive","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/mark_as_not_sensitive","href":"/api-reference/mark-chat-as-not-sensitive"},{"title":"Mark chat as read","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/mark_as_read","href":"/api-reference/mark-chat-as-read"},{"title":"Mark chat as unread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/mark_as_unread","href":"/api-reference/mark-chat-as-unread"}]},{"group":"Contact","expanded":false,"pages":[{"title":"Search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/search","href":"/api-reference/search-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts","href":"/api-reference/create-contact"},{"title":"Upsert contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/upsert","href":"/api-reference/upsert-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /contacts/{contactId}","href":"/api-reference/update-contact"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /contacts/{contactId}","href":"/api-reference/get-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /contacts/{contactId}","href":"/api-reference/delete-contact"},{"title":"Add labels to contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/{contactId}/labels","href":"/api-reference/add-labels-to-contact"},{"title":"Remove labels from contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /contacts/{contactId}/labels","href":"/api-reference/remove-labels-from-contact"},{"title":"Subscribe contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/{contactId}/subscribe","href":"/api-reference/subscribe-contact"},{"title":"Unsubscribe contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/{contactId}/unsubscribe","href":"/api-reference/unsubscribe-contact"},{"title":"Bulk upsert contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/bulk","href":"/api-reference/bulk-upsert-contacts"}]},{"group":"File","expanded":false,"pages":[{"title":"Upload file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /files","href":"/api-reference/upload-file"},{"title":"Get file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /files/{fileId}","href":"/api-reference/get-file"},{"title":"Get public file URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /files/{fileId}/public_url","href":"/api-reference/get-public-file-url"}]},{"group":"Journey","expanded":false,"pages":[{"title":"Search journeys","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /journeys/search","href":"/api-reference/search-journeys"},{"title":"Get journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /journeys/{journeyId}","href":"/api-reference/get-journey"},{"title":"Subscribe contacts to journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /journeys/{journeyId}/subscribe","href":"/api-reference/subscribe-contacts-to-journey"},{"title":"Unsubscribe contacts from journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /journeys/{journeyId}/unsubscribe","href":"/api-reference/unsubscribe-contacts-from-journey"}]},{"group":"Label","expanded":false,"pages":[{"title":"Search labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /labels/search","href":"/api-reference/search-labels"},{"title":"Create label","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /labels","href":"/api-reference/create-label"},{"title":"Update label","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /labels/{labelId}","href":"/api-reference/update-label"},{"title":"Get label","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /labels/{labelId}","href":"/api-reference/get-label"},{"title":"Delete label","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /labels/{labelId}","href":"/api-reference/delete-label"}]},{"group":"Message","expanded":false,"pages":[{"title":"Send message","openapi":"api-reference/openapi-v3.json POST /messages/send","href":"/api-reference/send-message"},{"title":"Send template message","openapi":"api-reference/openapi-v3.json POST /messages/send_template","href":"/api-reference/send-template-message"}]},{"group":"Message Template","expanded":false,"pages":[{"title":"Search message templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /message_templates/search","href":"/api-reference/search-message-templates"},{"title":"Create message template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /message_templates","href":"/api-reference/create-message-template"},{"title":"Update message template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /message_templates/{messageTemplateId}","href":"/api-reference/update-message-template"},{"title":"Get message template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /message_templates/{messageTemplateId}","href":"/api-reference/get-message-template"},{"title":"Delete message template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /message_templates/{messageTemplateId}","href":"/api-reference/delete-message-template"}]},{"group":"Team","expanded":false,"pages":[{"title":"Search teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /teams/search","href":"/api-reference/search-teams"},{"title":"Create team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /teams","href":"/api-reference/create-team"},{"title":"Update team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /teams/{teamId}","href":"/api-reference/update-team"},{"title":"Get team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /teams/{teamId}","href":"/api-reference/get-team"},{"title":"Delete team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /teams/{teamId}","href":"/api-reference/delete-team"}]},{"group":"User","expanded":false,"pages":[{"title":"Get users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /users","href":"/api-reference/get-users"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /users/{userId}","href":"/api-reference/get-user"}]},{"group":"Workspace","expanded":false,"pages":[{"title":"Get workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /workspace","href":"/api-reference/get-workspace"}]}]}]},{"version":"Version 2","tag":"Sunset Oct 1, 2026","pages":[{"title":"Version 2","href":"/api-reference/v2/overview"}]}]},{"tab":"Webhooks","icon":"webhook","groups":[{"group":"HEYY WEBHOOKS","pages":[{"title":"Introduction","href":"/webhooks/overview"},{"title":"Event types","href":"/webhooks/event-types"}]},{"group":"MESSAGE WEBHOOKS","pages":[{"title":"message.received","sidebarTitle":"message.received","href":"/webhooks/events/message-received"},{"title":"message.sent","sidebarTitle":"message.sent","href":"/webhooks/events/message-sent"},{"title":"message.updated","sidebarTitle":"message.updated","href":"/webhooks/events/message-updated"}]},{"group":"MANAGE WEBHOOKS","expanded":false,"pages":[{"title":"Create API webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /api_webhooks","href":"/api-reference/create-api-webhook"},{"title":"Update API webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /api_webhooks/{webhookId}","href":"/api-reference/update-api-webhook"},{"title":"Delete API webhook","description":"Delete API webhook.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /api_webhooks/{webhookId}","href":"/api-reference/delete-api-webhook"},{"title":"Search API webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /api_webhooks/search","href":"/api-reference/search-api-webhooks"}]}]},{"tab":"Changelog","icon":"megaphone","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Search API webhooks - Heyy Help Center","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}