Subscribe to whatsapp.echo_message.created.You receive this event when YCloud records an outbound echo for a Meta Business Agent onboarded through the Public REST API. Read the standard message-shaped content from whatsappMessage; do not use this event for customer inbound messages.The current contract keeps the event name unchanged while exposing the echo as a
standard WhatsApp message. Agent, handover, and Inbox routing fields are not part
of this payload.
All examples use placeholder identifiers. Route by the outer type and read
whatsappMessage, not whatsappMetaBusinessAgent, whatsappEchoMessage, or data.Deduplicate repeated deliveries with the outer id. The outer createTime is the
webhook event time; nested message time fields are RFC 3339 source times.
Use id or wamid to correlate later status events.
Read text from text.body. For media, inspect type and the corresponding content object. Media IDs are not public download URLs.
The customer phone and BSUID are independent. When the source callback supplies both, the event includes to together with recipientUserId or parentRecipientUserId. Missing identities are omitted and are not inferred from each other.
from is the business display phone number when the source callback supplies a valid phone number. It is not derived from phoneNumberId.
Reply context is normalized to the standard message contract. For example, source context.id is exposed as context.message_id.
Agent, handover, routing, pricing, and conversation fields are not included.
status is the stored status when the echo is processed; it is not guaranteed to be sent.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"YCloud Docs","description":"YCloud product documentation, API reference, and webhook payload documentation.","colors":{"primary":"#602DED","light":"#FD4C7D","dark":"#1a1e22"},"logo":{"light":"https://mintcdn.com/lchnan/AXn0jsI-c5aPnOMW/logo/light.png?fit=max\u0026auto=format\u0026n=AXn0jsI-c5aPnOMW\u0026q=85\u0026s=0865e4207d765d07a769c29bc819adbe","dark":"https://mintcdn.com/lchnan/AXn0jsI-c5aPnOMW/logo/dark.png?fit=max\u0026auto=format\u0026n=AXn0jsI-c5aPnOMW\u0026q=85\u0026s=1bafffbe886c0ac13b0409dc90d446f8","href":"https://www.ycloud.com"},"favicon":"https://mintcdn.com/lchnan/AXn0jsI-c5aPnOMW/favicon.png?fit=max\u0026auto=format\u0026n=AXn0jsI-c5aPnOMW\u0026q=85\u0026s=1eed9e0b562f4b06368d2b8185b801b4","api":{"openapi":["openapi/endpoints/ycloud-api-v2.yaml","openapi/webhooks/testing-webhooks.yaml"],"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","prefill":true,"autogenerate":false},"url":"full"},"background":{"color":{"light":"#ffffff"}},"navbar":{"links":[{"href":"https://www.ycloud.com/customer-support","label":"Support"},{"href":"https://www.ycloud.com/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.ycloud.com/console"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Inter","weight":650},"body":{"family":"Inter","weight":450}},"icons":{"library":"fontawesome"},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"schema":true},"navigation":{"languages":[{"language":"en","default":true,"href":"en/documentation/overview"},{"language":"zh","href":"zh/documentation/overview"},{"language":"es","href":"es/documentation/overview"},{"language":"pt","href":"pt/documentation/overview"},{"language":"ru","href":"ru/documentation/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lchnan","hasAudioNarration":false,"actualSubdomain":"lchnan","customDomains":["docs.ycloud.com"],"gitSource":{"type":"github","owner":"ycloud-developers","repo":"ycloud_docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"38a7c79a-935e-44ce-8ac4-771d9347bc89","liveDeploymentHistoryId":"6ae201baf9cefd8f8d7a475b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae201baf9cefd8f8d7a475b"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae201baf9cefd8f8d7a475b","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"en","tag":"Documentation","count":242},{"language":"es","tag":"Documentación","count":241},{"language":"pt","tag":"Documentação","count":241},{"language":"ru","tag":"Документация","count":241},{"language":"zh","tag":"产品文档","count":241},{"language":"default","tag":"API Reference","count":165},{"language":"default","tag":"Endpoints","count":165},{"language":"en","tag":"API Reference","count":68},{"language":"es","tag":"Referencia de la API","count":68},{"language":"pt","tag":"Referência da API","count":68},{"language":"ru","tag":"Справочник API","count":68},{"language":"zh","tag":"API 参考","count":68},{"language":"en","tag":"Guides","count":63},{"language":"es","tag":"Guías","count":63},{"language":"pt","tag":"Guias","count":63},{"language":"ru","tag":"Руководства","count":63},{"language":"zh","tag":"指南","count":63},{"language":"default","tag":"Meta Business Agent","count":63},{"language":"en","tag":"Channels","count":60},{"language":"es","tag":"Gestión de cuentas de WhatsApp","count":54},{"language":"pt","tag":"Gerenciamento de contas do WhatsApp","count":54},{"language":"ru","tag":"Управление аккаунтами WhatsApp","count":54},{"language":"zh","tag":"WhatsApp 账号管理","count":54},{"language":"en","tag":"Integrations","count":44},{"language":"es","tag":"Integraciones","count":44},{"language":"pt","tag":"Integrações","count":44},{"language":"ru","tag":"Интеграции","count":44},{"language":"zh","tag":"集成","count":44},{"language":"default","tag":"Configure","count":43},{"language":"en","tag":"WhatsApp Business Platform","count":40},{"language":"es","tag":"WhatsApp Business Platform","count":40},{"language":"pt","tag":"WhatsApp Business Platform","count":40},{"language":"ru","tag":"Платформа WhatsApp Business","count":40},{"language":"zh","tag":"WhatsApp 商业平台","count":40},{"language":"es","tag":"Canales","count":32},{"language":"pt","tag":"Canais","count":32},{"language":"ru","tag":"Каналы","count":32},{"language":"zh","tag":"渠道","count":32},{"language":"en","tag":"Examples","count":28},{"language":"en","tag":"WhatsApp Accounts Management","count":28},{"language":"es","tag":"Ejemplos","count":28},{"language":"pt","tag":"Exemplos","count":28},{"language":"ru","tag":"Примеры","count":28},{"language":"zh","tag":"示例","count":28},{"language":"en","tag":"Webhook examples","count":25},{"language":"en","tag":"Agents","count":25},{"language":"es","tag":"Ejemplos de Webhook","count":25},{"language":"es","tag":"Agentes","count":25},{"language":"pt","tag":"Exemplos de Webhook","count":25},{"language":"pt","tag":"Agentes","count":25},{"language":"ru","tag":"Примеры Webhook","count":25},{"language":"ru","tag":"Агенты","count":25},{"language":"zh","tag":"Webhook 示例","count":25},{"language":"zh","tag":"智能体","count":25},{"language":"default","tag":"WhatsApp Phone Numbers","count":15},{"language":"default","tag":"WhatsApp Groups","count":12},{"language":"default","tag":"Contacts","count":10},{"language":"default","tag":"Operate","count":10},{"language":"default","tag":"Connectors","count":10},{"language":"default","tag":"Onboard","count":9}],"searchSettings":{"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created","slug":"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created","pageMetadata":{"title":"Meta Business Agent echo message created","sidebarTitle":"Echo message created","description":"Store outbound text and media echoes from a Meta Business Agent onboarded through the Public REST API.","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"},"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: \"Store outbound text and media echoes from a Meta Business Agent onboarded through the Public REST API.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`what-it-is`,children:`What it is`}),`\n`,_jsxs(_components.p,{children:[`Subscribe to `,_jsx(_components.code,{children:`whatsapp.echo_message.created`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`You receive this event when YCloud records an outbound echo for a Meta Business Agent onboarded through the Public REST API. Read the standard message-shaped content from `,_jsx(_components.code,{children:`whatsappMessage`}),`; do not use this event for customer inbound messages.`]}),`\n`,_jsx(_components.p,{children:`The current contract keeps the event name unchanged while exposing the echo as a\nstandard WhatsApp message. Agent, handover, and Inbox routing fields are not part\nof this payload.`}),`\n`,_jsx(Heading,{level:`2`,id:`before-you-begin`,children:`Before you begin`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Onboard the Agent through the `,_jsx(_components.a,{href:`/en/api-reference/meta-business-agents/onboard`,children:`Public REST API`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Subscribe an active webhook endpoint in the same account to `,_jsx(_components.code,{children:`whatsapp.echo_message.created`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Verify `,_jsx(_components.code,{children:`YCloud-Signature`}),` against the raw request body, durably accept each event, and process it idempotently.`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Console-created Agents do not emit this customer webhook. Their Inbox synchronization is a separate flow.`})}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/en/api-reference/guides/api-fundamentals/configure-webhooks#subscribe-to-echo-and-handover-events`,children:`Configure webhooks`}),` for endpoint setup.`]}),`\n`,_jsx(Heading,{level:`2`,id:`how-it-works`,children:`How it works`}),`\n`,_jsxs(_components.p,{children:[`All examples use placeholder identifiers. Route by the outer `,_jsx(_components.code,{children:`type`}),` and read\n`,_jsx(_components.code,{children:`whatsappMessage`}),`, not `,_jsx(_components.code,{children:`whatsappMetaBusinessAgent`}),`, `,_jsx(_components.code,{children:`whatsappEchoMessage`}),`, or `,_jsx(_components.code,{children:`data`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Deduplicate repeated deliveries with the outer `,_jsx(_components.code,{children:`id`}),`. The outer `,_jsx(_components.code,{children:`createTime`}),` is the\nwebhook event time; nested message time fields are RFC 3339 source times.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Use `,_jsx(_components.code,{children:`id`}),` or `,_jsx(_components.code,{children:`wamid`}),` to correlate later status events.`]}),`\n`,_jsxs(_components.li,{children:[`Read text from `,_jsx(_components.code,{children:`text.body`}),`. For media, inspect `,_jsx(_components.code,{children:`type`}),` and the corresponding content object. Media IDs are not public download URLs.`]}),`\n`,_jsxs(_components.li,{children:[`The customer phone and BSUID are independent. When the source callback supplies both, the event includes `,_jsx(_components.code,{children:`to`}),` together with `,_jsx(_components.code,{children:`recipientUserId`}),` or `,_jsx(_components.code,{children:`parentRecipientUserId`}),`. Missing identities are omitted and are not inferred from each other.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`from`}),` is the business display phone number when the source callback supplies a valid phone number. It is not derived from `,_jsx(_components.code,{children:`phoneNumberId`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Reply context is normalized to the standard message contract. For example, source `,_jsx(_components.code,{children:`context.id`}),` is exposed as `,_jsx(_components.code,{children:`context.message_id`}),`.`]}),`\n`,_jsx(_components.li,{children:`Agent, handover, routing, pricing, and conversation fields are not included.`}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`status`}),` is the stored status when the echo is processed; it is not guaranteed to be `,_jsx(_components.code,{children:`sent`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Customer inbound messages use `,_jsx(_components.a,{href:`/en/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples`,children:_jsx(_components.code,{children:`whatsapp.inbound_message.received`})}),`. Business App echoes use `,_jsx(_components.a,{href:`/en/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples`,children:_jsx(_components.code,{children:`whatsapp.smb.message.echoes`})}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsxs(_components.p,{children:[`YCloud sends these JSON bodies in HTTP `,_jsx(_components.code,{children:`POST`}),` requests to your configured webhook URL.`]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`Return a `,_jsx(_components.code,{children:`2xx`}),` response after durably accepting each event. Process slow work asynchronously.`]}),`\n`,_jsx(Heading,{level:`2`,id:`outbound-text-echo`,children:`Outbound text echo`}),`\n`,_jsx(Heading,{level:`3`,id:`request-2`,children:`Request`}),`\n`,_jsx(_components.p,{children:`Store the text from whatsappMessage.text.body. id and wamid link subsequent status events.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`21`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`21`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"evt_example_echo_text\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"whatsapp.echo_message.created\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"apiVersion\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"v2\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"createTime\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-09-09T02:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"whatsappMessage\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"MESSAGE_ID\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"wamid\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"wamid.EXAMPLE\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"wabaId\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"WABA_ID\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"from\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"+12025550123\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"to\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"+12025550124\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"recipientUserId\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"GB.898232076600896\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"text\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"text\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"body\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"Hello! How can I help you?\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"sent\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"createTime\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-09-09T02:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"sendTime\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-09-09T02:00:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`response-2`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`HTTP`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`/`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`1.1`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` 200`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` OK`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`explanation`,children:`Explanation`}),`\n`,_jsxs(_components.p,{children:[`Read the echoed text from `,_jsx(_components.code,{children:`whatsappMessage.text.body`}),`. Use `,_jsx(_components.code,{children:`id`}),` or `,_jsx(_components.code,{children:`wamid`}),` to correlate later status events.`]}),`\n`,_jsx(Heading,{level:`2`,id:`outbound-image-echo`,children:`Outbound image echo`}),`\n`,_jsx(Heading,{level:`3`,id:`request-3`,children:`Request`}),`\n`,_jsx(_components.p,{children:`Message content varies by type. Treat media IDs as provider references, not public download URLs.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`22`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`22`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"evt_example_echo_image\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"whatsapp.echo_message.created\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"apiVersion\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"v2\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"createTime\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-09-09T02:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"whatsappMessage\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"IMAGE_MESSAGE_ID\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"wamid\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"wamid.IMAGE_EXAMPLE\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"wabaId\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"WABA_ID\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"from\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"+12025550123\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"to\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"+12025550124\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"recipientUserId\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"GB.898232076600896\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"image\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"image\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"MEDIA_ID\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"mime_type\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"image/jpeg\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"sent\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"createTime\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-09-09T02:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"sendTime\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-09-09T02:00:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`response-3`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`HTTP`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`/`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`1.1`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` 200`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` OK`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`explanation-2`,children:`Explanation`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`type`}),` to select the matching content object. Treat the media `,_jsx(_components.code,{children:`id`}),` as a provider reference.`]}),`\n`,_jsx(Heading,{level:`3`,id:`related-examples`,children:`Related examples`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated`,children:`WhatsApp echo message updated`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/en/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated`,children:`WhatsApp Agent handover updated`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/en/api-reference/guides/examples/webhook-examples/overview#echo-and-agent-handover-events`,children:`Echo and Agent handover examples`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/en/api-reference/guides/examples/webhook-examples/webhook-payload-examples`,children:`Complete payload catalog`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Meta Business Agent echo message created","sidebarTitle":"Echo message created","description":"Store outbound text and media echoes from a Meta Business Agent onboarded through the Public REST API.","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What it is","slug":"what-it-is","depth":2,"children":[]},{"title":"Before you begin","slug":"before-you-begin","depth":2,"children":[]},{"title":"How it works","slug":"how-it-works","depth":2,"children":[]},{"title":"Request","slug":"request","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Outbound text echo","slug":"outbound-text-echo","depth":2,"children":[{"title":"Request","slug":"request-2","depth":3,"children":[]},{"title":"Response","slug":"response-2","depth":3,"children":[]},{"title":"Explanation","slug":"explanation","depth":3,"children":[]}]},{"title":"Outbound image echo","slug":"outbound-image-echo","depth":2,"children":[{"title":"Request","slug":"request-3","depth":3,"children":[]},{"title":"Response","slug":"response-3","depth":3,"children":[]},{"title":"Explanation","slug":"explanation-2","depth":3,"children":[]},{"title":"Related examples","slug":"related-examples","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"lchnan","siteName":"YCloud Docs","title":"Meta Business Agent echo message created - YCloud Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created","matchLevel":0},"zh":{"href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created","matchLevel":1},"es":{"href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created","matchLevel":1},"pt":{"href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created","matchLevel":1},"ru":{"href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created","matchLevel":1}}},"lastModified":"2026-10-09T09:24:17.583Z","originalFileLocation":"en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Store outbound text and media echoes from a Meta Business Agent onboarded through the Public REST API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"YCloud Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Meta Business Agent echo message created - YCloud Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Store outbound text and media echoes from a Meta Business Agent onboarded through the Public REST API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"YCloud Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lchnan.mintlify.app/_mintlify/api/og/v2?division=Meta+Business+Agent\u0026amp;title=Meta+Business+Agent+echo+message+created\u0026amp;description=Store+outbound+text+and+media+echoes+from+a+Meta+Business+Agent+onboarded+through+the+Public+REST+API.\u0026amp;theme=7e639de6347778391fbe3ad7\u0026amp;signature=04ea9635fb694586cd25be8ef6d6136c291ba280fbd2fd4cdfa1755e69b9280f\">\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=\"Meta Business Agent echo message created - YCloud Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Store outbound text and media echoes from a Meta Business Agent onboarded through the Public REST API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lchnan.mintlify.app/_mintlify/api/og/v2?division=Meta+Business+Agent\u0026amp;title=Meta+Business+Agent+echo+message+created\u0026amp;description=Store+outbound+text+and+media+echoes+from+a+Meta+Business+Agent+onboarded+through+the+Public+REST+API.\u0026amp;theme=7e639de6347778391fbe3ad7\u0026amp;signature=04ea9635fb694586cd25be8ef6d6136c291ba280fbd2fd4cdfa1755e69b9280f\">\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/lchnan/g_kuIVCsIE9hrH5P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"YCloud Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#602DED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.ycloud.com/zh/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.ycloud.com/es/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.ycloud.com/pt/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://docs.ycloud.com/ru/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ycloud.com/#organization\",\"name\":\"YCloud Docs\",\"url\":\"https://docs.ycloud.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lchnan/AXn0jsI-c5aPnOMW/logo/light.png?fit=max\u0026auto=format\u0026n=AXn0jsI-c5aPnOMW\u0026q=85\u0026s=0865e4207d765d07a769c29bc819adbe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ycloud.com#website\",\"name\":\"YCloud Docs\",\"url\":\"https://docs.ycloud.com\",\"publisher\":{\"@id\":\"https://docs.ycloud.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created#webpage\",\"url\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\",\"name\":\"Meta Business Agent echo message created\",\"description\":\"Store outbound text and media echoes from a Meta Business Agent onboarded through the Public REST API.\",\"dateModified\":\"2026-10-09T09:24:17.583Z\",\"isPartOf\":{\"@id\":\"https://docs.ycloud.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Guides\",\"item\":\"https://docs.ycloud.com/en/api-reference/guides/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Examples\",\"item\":\"https://docs.ycloud.com/en/api-reference/guides/examples/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Webhook examples\",\"item\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/overview\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Meta Business Agent echo message created\",\"item\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created#article\",\"headline\":\"Meta Business Agent echo message created\",\"name\":\"Meta Business Agent echo message created\",\"description\":\"Store outbound text and media echoes from a Meta Business Agent onboarded through the Public REST API.\",\"url\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created#webpage\"},\"dateModified\":\"2026-10-09T09:24:17.583Z\",\"publisher\":{\"@id\":\"https://docs.ycloud.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ycloud.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"YCloud Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"YCloud Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/en/documentation/overview"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Getting Started","pages":[{"title":"YCloud API","href":"/en/api-reference/getting-started/ycloud-api"},{"title":"Quickstart","href":"/en/api-reference/getting-started/quickstart"},{"title":"API changelog","href":"/en/api-reference/getting-started/changelog"}]},{"group":"Guides","pages":[{"title":"Guides","href":"/en/api-reference/guides/overview"},{"group":"API fundamentals","pages":[{"title":"Authentication","href":"/en/api-reference/guides/api-fundamentals/authentication"},{"title":"Handle errors","href":"/en/api-reference/guides/api-fundamentals/handle-errors"},{"title":"Rate limits","href":"/en/api-reference/guides/api-fundamentals/rate-limits"},{"title":"Pagination","href":"/en/api-reference/guides/api-fundamentals/pagination"},{"title":"API versioning and compatibility","href":"/en/api-reference/guides/api-fundamentals/versioning"},{"title":"Configure webhooks","href":"/en/api-reference/guides/api-fundamentals/configure-webhooks"},{"title":"Implement a webhook receiver","href":"/en/api-reference/guides/api-fundamentals/implement-a-webhook-receiver"}]},{"group":"WhatsApp platform","pages":[{"group":"Send and receive","pages":[{"title":"Send a WhatsApp message","href":"/en/api-reference/guides/whatsapp-platform/send-whatsapp-message"},{"title":"WhatsApp error code","href":"/en/api-reference/guides/whatsapp-platform/whatsapp-error-code"},{"title":"Handle WhatsApp inbound messages","href":"/en/api-reference/guides/whatsapp-platform/handle-whatsapp-inbound-messages"},{"title":"Upload WhatsApp media","href":"/en/api-reference/guides/whatsapp-platform/upload-whatsapp-media"},{"title":"WhatsApp Message Pricing Integration Guide","href":"/en/api-reference/guides/whatsapp-platform/whatsapp-message-pricing-integration-guide"},{"title":"Max Price Integration Guide","href":"/en/api-reference/guides/whatsapp-platform/max-price-integration-guide"}]},{"group":"Best practices","pages":[{"title":"WhatsApp Messages API best practices","href":"/en/api-reference/guides/whatsapp-platform/whatsapp-messages-api-best-practices"},{"title":"Direct Send best practices","href":"/en/api-reference/guides/whatsapp-platform/best-practices/direct-send"}]},{"group":"Business accounts","pages":[{"title":"Manage WhatsApp Business Accounts","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts"},{"title":"Manage WhatsApp phone numbers","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-phone-numbers"},{"title":"Use business-scoped user IDs","href":"/en/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids"}]},{"group":"Templates and flows","pages":[{"title":"Manage WhatsApp templates","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-templates"},{"title":"Supported WhatsApp template languages","href":"/en/api-reference/guides/whatsapp-platform/supported-whatsapp-template-languages"},{"title":"Manage WhatsApp Flows","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-flows"},{"title":"Implement a WhatsApp Flow endpoint","href":"/en/api-reference/guides/whatsapp-platform/implement-a-whatsapp-flow-endpoint"}]},{"group":"Calling and groups","pages":[{"title":"Manage WhatsApp calls","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-calls"},{"title":"Manage WhatsApp groups","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-groups"}]}]},{"group":"Meta Business Agent","pages":[{"title":"Meta Business Agent overview","href":"/en/documentation/meta-business-agent/overview"},{"title":"Prepare and check eligibility","href":"/en/documentation/meta-business-agent/prepare-and-check-eligibility"},{"title":"Onboard and configure","href":"/en/documentation/meta-business-agent/onboard-and-configure"},{"title":"Test and evaluate","href":"/en/documentation/meta-business-agent/test-and-evaluate"},{"title":"Roll out safely","href":"/en/documentation/meta-business-agent/roll-out-safely"},{"title":"Operate and troubleshoot","href":"/en/documentation/meta-business-agent/operate-and-troubleshoot"}]},{"group":"Customer data and operations","pages":[{"title":"Check account balance","href":"/en/api-reference/guides/customer-data-and-operations/check-account-balance"},{"title":"Manage contacts","href":"/en/api-reference/guides/customer-data-and-operations/manage-contacts"},{"title":"Track custom events","href":"/en/api-reference/guides/customer-data-and-operations/track-custom-events"},{"title":"Manage unsubscribers","href":"/en/api-reference/guides/customer-data-and-operations/manage-unsubscribers"}]},{"group":"Examples","pages":[{"title":"API and webhook examples","href":"/en/api-reference/guides/examples/overview"},{"group":"API examples","pages":[{"title":"WhatsApp Template Creation Examples","href":"/en/api-reference/guides/examples/api-examples/whatsapp-template-creation-examples"},{"title":"WhatsApp Messaging Examples","href":"/en/api-reference/guides/examples/api-examples/whatsapp-messaging-examples"}]},{"group":"Webhook examples","pages":[{"title":"Webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/overview"},{"group":"Messages","pages":[{"title":"Message status webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples"},{"title":"Inbound message and preference webhook examples","description":"Handle inbound WhatsApp, Messenger, and SMS messages, plus WhatsApp marketing preferences.","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples"}]},{"group":"Meta Business Agent","pages":[{"title":"Meta Business Agent echo message created","sidebarTitle":"Echo message created","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"},{"title":"Meta Business Agent echo message updated","sidebarTitle":"Echo message updated","description":"Track delivery and failure statuses for Meta Business Agent message echoes.","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated"},{"title":"Meta Business Agent control handover","sidebarTitle":"Control handover","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"WhatsApp Business App History Message Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples"},{"title":"WhatsApp Business App Sent Message Sync Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples"}]},{"group":"Templates and accounts","pages":[{"title":"WhatsApp template webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples"},{"title":"WhatsApp account and phone number webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples"}]},{"group":"Calling","pages":[{"title":"WhatsApp Calling Connect Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples"},{"title":"WhatsApp Calling Status Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples"},{"title":"WhatsApp call termination and capture webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples"}]},{"group":"Groups","pages":[{"title":"WhatsApp Group Lifecycle Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples"},{"title":"WhatsApp Group Participants Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples"},{"title":"WhatsApp Group Settings Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples"},{"title":"WhatsApp Group Status Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples"}]},{"group":"Flows","pages":[{"title":"WhatsApp Flow Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples"}]},{"group":"Payments","pages":[{"title":"WhatsApp Payment Updated Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples"}]},{"group":"Contacts and opt-outs","pages":[{"title":"Contact and note creation webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples"},{"title":"Contact and note deletion webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples"},{"title":"Contact and note update webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples"},{"title":"Contact Unsubscribe Created Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples"},{"title":"Contact Unsubscribe Deleted Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples"}]},{"title":"Webhook payload examples","href":"/en/api-reference/guides/examples/webhook-examples/webhook-payload-examples"}]}]}]},{"group":"Endpoints","pages":[{"group":"WhatsApp Business Accounts","pages":[{"title":"List WABAs","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/businessAccounts","href":"/api-reference/whatsapp-business-accounts/list-wabas"},{"title":"Retrieve a WABA","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/businessAccounts/{id}","href":"/api-reference/whatsapp-business-accounts/retrieve-a-waba"},{"title":"Retrieve WABA automatic creative optimizations","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/businessAccounts/{wabaId}/automatic-creative-optimizations","href":"/api-reference/whatsapp-business-accounts/retrieve-waba-automatic-creative-optimizations"},{"title":"Update WABA automatic creative optimizations","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/businessAccounts/{wabaId}/automatic-creative-optimizations","href":"/api-reference/whatsapp-business-accounts/update-waba-automatic-creative-optimizations"}]},{"group":"WhatsApp Inbound Messages","pages":[{"title":"Mark message as read","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/inboundMessages/{id}/markAsRead","href":"/api-reference/whatsapp-inbound-messages/mark-message-as-read"},{"title":"Mark message as read and display a typing indicator with a JSON response","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/inboundMessages/{id}/typing","href":"/api-reference/whatsapp-inbound-messages/mark-message-as-read-and-display-a-typing-indicator-with-a-json-response"}]},{"group":"WhatsApp Media","pages":[{"title":"Upload media","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/media/{phoneNumber}/upload","href":"/api-reference/whatsapp-media/upload-media"}]},{"group":"WhatsApp Messages","pages":[{"title":"Send a message directly","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/messages/sendDirectly","href":"/api-reference/whatsapp-messages/send-a-message-directly"},{"title":"Enqueue a message","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/messages","href":"/api-reference/whatsapp-messages/enqueue-a-message"},{"title":"Retrieve a message","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/messages/{id}","href":"/api-reference/whatsapp-messages/retrieve-a-message"},{"title":"Submit a Direct Send message sample","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/messages/{wabaId}/messageSamples","href":"/api-reference/whatsapp-messages/submit-a-direct-send-message-sample"}]},{"group":"Messenger Messages","pages":[{"title":"Send a Messenger text reply directly","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /messenger/messages/sendDirectly","href":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly"},{"title":"Retrieve an outbound message by its YCloud ID","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /messenger/messages/{id}","href":"/api-reference/messenger-messages/retrieve-an-outbound-message-by-its-ycloud-id"},{"title":"Retrieve an outbound message by its Meta message ID","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /messenger/messages/retrieveByMetaMessageId","href":"/api-reference/messenger-messages/retrieve-an-outbound-message-by-its-meta-message-id"}]},{"group":"WhatsApp Blocked Users","pages":[{"title":"Block users","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/blockUsers","href":"/api-reference/whatsapp-blocked-users/block-users"},{"title":"Unblock users","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/unblockUsers","href":"/api-reference/whatsapp-blocked-users/unblock-users"},{"title":"List blocked users","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/blockedUsers","href":"/api-reference/whatsapp-blocked-users/list-blocked-users"}]},{"group":"WhatsApp Groups","pages":[{"title":"Create a group","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups","href":"/api-reference/whatsapp-groups/create-a-group"},{"title":"List groups","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/groups","href":"/api-reference/whatsapp-groups/list-groups"},{"title":"Retrieve a group","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/groups/{groupId}","href":"/api-reference/whatsapp-groups/retrieve-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/{businessPhoneNumber}/groups/{groupId}","href":"/api-reference/whatsapp-groups/delete-a-group"},{"title":"Retrieve a group invite link","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/groups/{groupId}/inviteLink","href":"/api-reference/whatsapp-groups/retrieve-a-group-invite-link"},{"title":"Reset a group invite link","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups/{groupId}/inviteLink/reset","href":"/api-reference/whatsapp-groups/reset-a-group-invite-link"},{"title":"Send a group invite link message","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups/inviteLink/messages","href":"/api-reference/whatsapp-groups/send-a-group-invite-link-message"},{"title":"List group join requests","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/groups/{groupId}/joinRequests","href":"/api-reference/whatsapp-groups/list-group-join-requests"},{"title":"Approve group join requests","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups/{groupId}/joinRequests/approve","href":"/api-reference/whatsapp-groups/approve-group-join-requests"},{"title":"Reject group join requests","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups/{groupId}/joinRequests/reject","href":"/api-reference/whatsapp-groups/reject-group-join-requests"},{"title":"Remove group participants","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/groups/{groupId}/participants/remove","href":"/api-reference/whatsapp-groups/remove-group-participants"},{"title":"Update group settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/{businessPhoneNumber}/groups/{groupId}/settings","href":"/api-reference/whatsapp-groups/update-group-settings"}]},{"group":"WhatsApp Calling","pages":[{"title":"Connect a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/connect","href":"/api-reference/whatsapp-calling/connect-a-call"},{"title":"Pre-accept a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/preAccept","href":"/api-reference/whatsapp-calling/pre-accept-a-call"},{"title":"Accept a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/accept","href":"/api-reference/whatsapp-calling/accept-a-call"},{"title":"Terminate a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/terminate","href":"/api-reference/whatsapp-calling/terminate-a-call"},{"title":"Reject a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/reject","href":"/api-reference/whatsapp-calling/reject-a-call"},{"title":"Download call media","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/calls/media/{mediaAssetId}","href":"/api-reference/whatsapp-calling/download-call-media"}]},{"group":"WhatsApp Phone Numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers","href":"/api-reference/whatsapp-phone-numbers/list-phone-numbers"},{"title":"Retrieve a phone number","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}","href":"/api-reference/whatsapp-phone-numbers/retrieve-a-phone-number"},{"title":"Retrieve a phone number profile","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/profile","href":"/api-reference/whatsapp-phone-numbers/retrieve-a-phone-number-profile"},{"title":"Update a phone number profile","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/profile","href":"/api-reference/whatsapp-phone-numbers/update-a-phone-number-profile"},{"title":"Update a phone number display name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/displayName","href":"/api-reference/whatsapp-phone-numbers/update-a-phone-number-display-name"},{"title":"Retrieve commerce settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/whatsappCommerceSettings","href":"/api-reference/whatsapp-phone-numbers/retrieve-commerce-settings"},{"title":"Update commerce settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/whatsappCommerceSettings","href":"/api-reference/whatsapp-phone-numbers/update-commerce-settings"},{"title":"Register a phone number","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/register","href":"/api-reference/whatsapp-phone-numbers/register-a-phone-number"},{"title":"Retrieve phone number settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/settings","href":"/api-reference/whatsapp-phone-numbers/retrieve-phone-number-settings"},{"title":"Save phone number settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/settings","href":"/api-reference/whatsapp-phone-numbers/save-phone-number-settings"},{"title":"Retrieve a phone number business username","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername","href":"/api-reference/whatsapp-phone-numbers/retrieve-a-phone-number-business-username"},{"title":"Retrieve phone number business username suggestions","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername/suggestions","href":"/api-reference/whatsapp-phone-numbers/retrieve-phone-number-business-username-suggestions"},{"title":"Update a phone number business username","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername","href":"/api-reference/whatsapp-phone-numbers/update-a-phone-number-business-username"},{"title":"Delete a phone number business username","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername","href":"/api-reference/whatsapp-phone-numbers/delete-a-phone-number-business-username"},{"title":"Delete a Meta contact book entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}","href":"/api-reference/whatsapp-phone-numbers/delete-a-meta-contact-book-entry"}]},{"group":"WhatsApp Templates","pages":[{"title":"Create a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates","href":"/api-reference/whatsapp-templates/create-a-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Retrieve WhatsApp template analytics","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates/analytics","href":"/api-reference/whatsapp-templates/retrieve-whatsapp-template-analytics"},{"title":"Delete templates by name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}","href":"/api-reference/whatsapp-templates/delete-templates-by-name"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Edit a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/edit-a-template"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/retrieve-a-template"}]},{"group":"WhatsApp Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows","href":"/api-reference/whatsapp-flows/create-a-flow"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows","href":"/api-reference/whatsapp-flows/list-flows"},{"title":"Update flow metadata","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/metadata","href":"/api-reference/whatsapp-flows/update-flow-metadata"},{"title":"Update flow structure","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/assets","href":"/api-reference/whatsapp-flows/update-flow-structure"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/delete-a-flow"},{"title":"Retrieve a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/retrieve-a-flow"},{"title":"Publish a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/publish","href":"/api-reference/whatsapp-flows/publish-a-flow"},{"title":"Deprecate a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/deprecate","href":"/api-reference/whatsapp-flows/deprecate-a-flow"},{"title":"generate a web preview URL with this flow.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}/preview","href":"/api-reference/whatsapp-flows/generate-a-web-preview-url-with-this-flow"}]},{"group":"Balance","pages":[{"title":"Retrieve balance","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /balance","href":"/api-reference/balance/retrieve-balance"}]},{"group":"Contacts","pages":[{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /contact/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /contact/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Retrieve a contact","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /contact/contacts/{id}","href":"/api-reference/contacts/retrieve-a-contact"},{"title":"List contact notes","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /contact/contacts/{contactIdentifier}/notes","href":"/api-reference/contacts/list-contact-notes"},{"title":"Create a contact note","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /contact/contacts/{contactIdentifier}/notes","href":"/api-reference/contacts/create-a-contact-note"},{"title":"Update a contact note","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /contact/notes/{noteId}","href":"/api-reference/contacts/update-a-contact-note"},{"title":"Delete a contact note","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /contact/notes/{noteId}","href":"/api-reference/contacts/delete-a-contact-note"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /contact/contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /contact/contacts/{id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"List contact attributes","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /contact/contacts/attributes","href":"/api-reference/contacts/list-contact-attributes"}]},{"group":"Custom Events","pages":[{"title":"Create an event definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /event/definitions","href":"/api-reference/custom-events/create-an-event-definition"},{"title":"Retrieve an event definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /event/definitions/{name}","href":"/api-reference/custom-events/retrieve-an-event-definition"},{"title":"Update an event definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /event/definitions/{name}","href":"/api-reference/custom-events/update-an-event-definition"},{"title":"Create an event property definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /event/definitions/{name}/properties","href":"/api-reference/custom-events/create-an-event-property-definition"},{"title":"Update an event property definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /event/definitions/{name}/properties/{propertyName}","href":"/api-reference/custom-events/update-an-event-property-definition"},{"title":"Delete an event property definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /event/definitions/{name}/properties/{propertyName}","href":"/api-reference/custom-events/delete-an-event-property-definition"},{"title":"Send an event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /event/events","href":"/api-reference/custom-events/send-an-event"}]},{"group":"Emails","pages":[{"title":"Send an email","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /emails","href":"/api-reference/emails/send-an-email"}]},{"group":"SMS","pages":[{"title":"Send an SMS","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /sms","href":"/api-reference/sms/send-an-sms"},{"title":"List SMS records","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /sms","href":"/api-reference/sms/list-sms-records"}]},{"group":"Unsubscribers","pages":[{"title":"Create an unsubscriber","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /unsubscribers","href":"/api-reference/unsubscribers/create-an-unsubscriber"},{"title":"List unsubscribers","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /unsubscribers","href":"/api-reference/unsubscribers/list-unsubscribers"},{"title":"List all unsubscribers by customer","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /unsubscribers/{customer}","href":"/api-reference/unsubscribers/list-all-unsubscribers-by-customer"},{"title":"Retrieve an unsubscriber","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /unsubscribers/{customer}/{channel}","href":"/api-reference/unsubscribers/retrieve-an-unsubscriber"},{"title":"Delete an unsubscriber","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /unsubscribers/{customer}/{channel}","href":"/api-reference/unsubscribers/delete-an-unsubscriber"}]},{"group":"Verify","pages":[{"title":"Start a verification","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /verify/verifications","href":"/api-reference/verify/start-a-verification"},{"title":"Check a verification","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /verify/verificationChecks","href":"/api-reference/verify/check-a-verification"}]},{"group":"Voices","pages":[{"title":"Send a voice code","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /voices","href":"/api-reference/voices/send-a-voice-code"},{"title":"List voice records","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /voices","href":"/api-reference/voices/list-voice-records"}]},{"group":"Webhook Endpoints","pages":[{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /webhookEndpoints","href":"/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /webhookEndpoints","href":"/api-reference/webhook-endpoints/list-webhook-endpoints"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /webhookEndpoints/{id}","href":"/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /webhookEndpoints/{id}","href":"/api-reference/webhook-endpoints/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /webhookEndpoints/{id}","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"},{"title":"Rotate a webhook endpoint secret","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /webhookEndpoints/{id}/rotateSecret","href":"/api-reference/webhook-endpoints/rotate-a-webhook-endpoint-secret"}]},{"group":"Meta Business Agent","pages":[{"title":"Meta Business Agent overview","href":"/en/api-reference/meta-business-agents/overview"},{"group":"Configure","pages":[{"group":"Agent Knowledge - Business Info","pages":[{"title":"Get Business Info","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/businessInfo","href":"/api-reference/meta-business-agents/get-business-info"},{"title":"Replace Business Info","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/businessInfo","href":"/api-reference/meta-business-agents/replace-business-info"},{"title":"Delete Business Info","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/businessInfo","href":"/api-reference/meta-business-agents/delete-business-info"}]},{"group":"Agent Knowledge - FAQs","pages":[{"title":"List Faqs","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/faqs","href":"/api-reference/meta-business-agents/list-faqs"},{"title":"Create Faq","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/faqs","href":"/api-reference/meta-business-agents/create-faq"},{"title":"Get Faq","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/faqs/{faqId}","href":"/api-reference/meta-business-agents/get-faq"},{"title":"Update Faq","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/faqs/{faqId}","href":"/api-reference/meta-business-agents/update-faq"},{"title":"Delete Faq","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/faqs/{faqId}","href":"/api-reference/meta-business-agents/delete-faq"}]},{"group":"Agent Knowledge - Files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/files","href":"/api-reference/meta-business-agents/list-files"},{"title":"Upload File","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/files","href":"/api-reference/meta-business-agents/upload-file"},{"title":"Get File","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/files/{fileId}","href":"/api-reference/meta-business-agents/get-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/files/{fileId}","href":"/api-reference/meta-business-agents/delete-file"}]},{"group":"Agent Knowledge - Websites","pages":[{"title":"List Websites","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/websites","href":"/api-reference/meta-business-agents/list-websites"},{"title":"Create Website","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/websites","href":"/api-reference/meta-business-agents/create-website"},{"title":"Get Website","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/websites/{websiteId}","href":"/api-reference/meta-business-agents/get-website"},{"title":"Update Website","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/websites/{websiteId}","href":"/api-reference/meta-business-agents/update-website"},{"title":"Delete Website","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/websites/{websiteId}","href":"/api-reference/meta-business-agents/delete-website"}]},{"group":"Agent Skills","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/skills","href":"/api-reference/meta-business-agents/list-skills"},{"title":"Create Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/skills","href":"/api-reference/meta-business-agents/create-skill"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/skills/{skillId}","href":"/api-reference/meta-business-agents/get-skill"},{"title":"Update Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/skills/{skillId}","href":"/api-reference/meta-business-agents/update-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/skills/{skillId}","href":"/api-reference/meta-business-agents/delete-skill"}]},{"group":"UI Skills","pages":[{"title":"List UI Skills","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/uiSkills","href":"/api-reference/meta-business-agents/list-ui-skills"},{"title":"Create UI Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/uiSkills","href":"/api-reference/meta-business-agents/create-ui-skill"},{"title":"Get UI Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/uiSkills/{skillId}","href":"/api-reference/meta-business-agents/get-ui-skill"},{"title":"Update UI Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/uiSkills/{skillId}","href":"/api-reference/meta-business-agents/update-ui-skill"},{"title":"Delete UI Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/uiSkills/{skillId}","href":"/api-reference/meta-business-agents/delete-ui-skill"}]},{"group":"Connector Tools","pages":[{"title":"List Connector Tools","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools","href":"/api-reference/meta-business-agents/list-connector-tools"},{"title":"Create Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools","href":"/api-reference/meta-business-agents/create-connector-tool"},{"title":"Get Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools/{toolId}","href":"/api-reference/meta-business-agents/get-connector-tool"},{"title":"Update Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools/{toolId}","href":"/api-reference/meta-business-agents/update-connector-tool"},{"title":"Delete Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools/{toolId}","href":"/api-reference/meta-business-agents/delete-connector-tool"},{"title":"Run Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools/{toolId}/runs","href":"/api-reference/meta-business-agents/run-connector-tool"}]},{"group":"Connectors","pages":[{"title":"List Connectors","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors","href":"/api-reference/meta-business-agents/list-connectors"},{"title":"Create Connector","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/connectors","href":"/api-reference/meta-business-agents/create-connector"},{"title":"Get Connector","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}","href":"/api-reference/meta-business-agents/get-connector"},{"title":"Update Connector","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/connectors/{connectorId}","href":"/api-reference/meta-business-agents/update-connector"},{"title":"Refresh MCP Connector Tools","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/connectors/{connectorId}/refreshMCPTools","href":"/api-reference/meta-business-agents/refresh-mcp-connector-tools"},{"title":"Delete Connector","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/connectors/{connectorId}","href":"/api-reference/meta-business-agents/delete-connector"},{"title":"Upsert Connector Certificate","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/connectors/{connectorId}/credentials/certificate","href":"/api-reference/meta-business-agents/upsert-connector-certificate"},{"title":"Upsert Connector Api Key","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/connectors/{connectorId}/credentials/apiKey","href":"/api-reference/meta-business-agents/upsert-connector-api-key"},{"title":"Upsert Connector O Auth","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/connectors/{connectorId}/credentials/oauth","href":"/api-reference/meta-business-agents/upsert-connector-o-auth"},{"title":"List Connector Logs","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}/logs","href":"/api-reference/meta-business-agents/list-connector-logs"}]}]},{"group":"Delete Agent","pages":[{"title":"Delete Agent","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}","href":"/api-reference/meta-business-agents/delete-agent"}]},{"group":"Onboard","pages":[{"group":"Agent Allowlist","pages":[{"title":"List Allowlist","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/allowListEntries","href":"/api-reference/meta-business-agents/list-allowlist"},{"title":"Create Allowlist Entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/allowListEntries","href":"/api-reference/meta-business-agents/create-allowlist-entry"},{"title":"Delete Allowlist Entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/allowListEntries/{entryId}","href":"/api-reference/meta-business-agents/delete-allowlist-entry"}]},{"group":"Agent Eligibility","pages":[{"title":"Check Eligibility","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/eligibility","href":"/api-reference/meta-business-agents/check-eligibility"}]},{"group":"Agent Onboarding","pages":[{"title":"Onboard Agent","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/onboarding","href":"/api-reference/meta-business-agents/onboard-agent"}]},{"group":"Agent Settings","pages":[{"title":"Get Settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/settings","href":"/api-reference/meta-business-agents/get-settings"},{"title":"Replace Settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/settings","href":"/api-reference/meta-business-agents/replace-settings"}]},{"group":"Agent Budgets","pages":[{"title":"Get Budgets","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/budgets","href":"/api-reference/meta-business-agents/get-budgets"},{"title":"Replace Budgets","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/budgets","href":"/api-reference/meta-business-agents/replace-budgets"}]}]},{"group":"Operate","pages":[{"group":"Agent Eval","pages":[{"title":"List Eval Cases","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/evalCases","href":"/api-reference/meta-business-agents/list-eval-cases"},{"title":"Get Eval Summary","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/evalSummaries","href":"/api-reference/meta-business-agents/get-eval-summary"},{"title":"Get Eval Details","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/evals","href":"/api-reference/meta-business-agents/get-eval-details"},{"title":"Get Eval Run Status","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/evalRuns/{jobId}","href":"/api-reference/meta-business-agents/get-eval-run-status"},{"title":"Submit Eval Run","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/evalRuns","href":"/api-reference/meta-business-agents/submit-eval-run"}]},{"group":"Agent Event","pages":[{"title":"Submit Agent Event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/events","href":"/api-reference/meta-business-agents/submit-agent-event"},{"title":"Get Agent Event Status","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/events/{agentEventId}","href":"/api-reference/meta-business-agents/get-agent-event-status"}]},{"group":"Agent Test","pages":[{"title":"Test Agent","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/tests","href":"/api-reference/meta-business-agents/test-agent"}]},{"group":"Conversation Turns","pages":[{"title":"Get Conversation Turns","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/conversationTurns","href":"/api-reference/meta-business-agents/get-conversation-turns"}]},{"group":"Thread Control (Cloud API)","pages":[{"title":"Control Thread","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/threadControl","href":"/api-reference/meta-business-agents/control-thread"}]}]}]}]},{"group":"Webhooks","pages":[{"title":"Test webhooks","sidebarTitle":"Test webhooks","openapi":"openapi/webhooks/testing-webhooks.yaml POST /webhooks/ycloud","playground":"interactive","href":"/en/api-reference/webhooks/test-webhooks"}]}]},{"tab":"Partner Center","icon":"handshake","pages":[{"title":"Partner Center","href":"/en/partner-center/overview"}]}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"}]},{"language":"ru","pages":[{"title":"ru","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"}]}]},"title":"Meta Business Agent echo message created - YCloud Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":[],"chunks":[]}