# WhatsApp Incoming Webhook Payload | Developer Documentation

<div id="bkmrk-whatsapp-incoming-we"><div><div>## WhatsApp Incoming Webhook Payload

<div><div><div><span>Copy for LLM</span></div></div><div>[<span>View as Markdown</span>](/books/meta-whatsapp/page/whatsapp-incoming-webhook-payload-developer-documentation)</div></div></div><div><div>Version</div></div><div><div><div><div><div><div><span><span>Schemas for incoming WhatsApp webhook notifications.</span></span></div></div><div><div><span><span>Defines payload structures for messages, status updates, and user interactions</span></span></div></div><div><div><span><span>sent from WhatsApp users to businesses via webhooks.</span></span></div></div></div></div></div></div></div><div><div>---

<div><div><div id="bkmrk-post-%2Fwhatsapp%2Fwebho"><div id="bkmrk-post-%2Fwhatsapp%2Fwebho-1"><div>### POST /whatsapp/webhooks

</div></div></div><div><div><div><div><div><div><span><span>Endpoint for receiving webhook payloads for diverse incoming WhatsApp message types.</span></span></div></div></div></div></div></div>#### Request Syntax

<div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div></div></div><div><span>Required</span>---

<div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>WebhookPayload</span></div><div><div><div id="bkmrk-show-child-attribute"><div><span>Show child attributes</span></div></div><div id="bkmrk-webhookpayloadobject"><div>---

<div><span>WebhookPayload</span></div><div>---

<div><div><span>object</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Always 'whatsapp\_business\_account' for these webhooks.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>entry</span><span>array of Entry</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-1"><div><span>Show child attributes</span></div></div><div id="bkmrk-entry%5B%5Dentryshow-chi"><div><div>---

<div><div><span>entry\[\]</span><span>Entry</span></div></div><div><div><div id="bkmrk-show-child-attribute-2"><div><span>Show child attributes</span></div></div><div id="bkmrk-idstring%C2%B7requiredwha"><div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp Business Account ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>changes</span><span>array of Change</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-3"><div><span>Show child attributes</span></div></div><div id="bkmrk-changes%5B%5Dchangeshow-"><div><div>---

<div><div><span>changes\[\]</span><span>Change</span></div></div><div><div><div id="bkmrk-show-child-attribute-4"><div><span>Show child attributes</span></div></div><div id="bkmrk-valuemust-be-one-of%3A"><div><div>---

<div><div><span>value</span><span>Must be one of: IncomingMessageValueGeneral, IncomingMessageValueSystem, StatusMessageValue, GroupValue</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-5"><div><span>Show child attributes</span></div></div><div id="bkmrk-incomingmessagevalue"><div><div>---

<div><div><span>IncomingMessageValueGeneral</span></div></div><div><div><div id="bkmrk-show-child-attribute-6"><div><span>Show child attributes</span></div></div><div id="bkmrk-messaging_productstr"><div><div>---

<div><div><span>messaging\_product</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Always 'whatsapp'.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>metadata</span><span>Metadata</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-7"><div><span>Show child attributes</span></div></div><div id="bkmrk-display_phone_number"><div><div>---

<div><div><span>display\_phone\_number</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business display phone number.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>phone\_number\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business phone number ID.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>contacts</span><span>array of ContactProfile</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Array of contact profiles for the sender. Included for all non-system incoming messages.</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-8"><div><span>Show child attributes</span></div></div><div id="bkmrk-contacts%5B%5Dcontactpro"><div><div>---

<div><div><span>contacts\[\]</span><span>ContactProfile</span></div></div><div><div><div id="bkmrk-show-child-attribute-9"><div><span>Show child attributes</span></div></div><div id="bkmrk-profileobject%C2%B7requir"><div><div>---

<div><div><span>profile</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-10"><div><span>Show child attributes</span></div></div><div id="bkmrk-namestring%C2%B7requiredw"><div><div>---

<div><div><span>name</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user's name as it appears in their profile in the WhatsApp client.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>wa\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>WhatsApp user ID. Note that a WhatsApp user's ID and phone number may not always match.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>messages</span><span>array of IncomingMessage</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Array of message objects. The structure varies based on the 'type' property.</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-11"><div><span>Show child attributes</span></div></div><div id="bkmrk-messages%5B%5Dincomingme"><div><div>---

<div><div><span>messages\[\]</span><span>IncomingMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-12"><div><span>Show child attributes</span></div></div><div id="bkmrk-textmessageshow-chil"><div><div>---

<div><div><span>TextMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-13"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"text"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>text</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-14"><div><span>Show child attributes</span></div></div><div id="bkmrk-bodystring%C2%B7requiredt"><div><div>---

<div><div><span>body</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Text body of the message.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>context</span><span>object</span></div><div><div><div><div><div><div><span><span>Only included if message via a "Message business" button.</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-15"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredb"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business display phone number.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp message ID of the message the user used to access the "Message business" button.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>referred\_product</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-16"><div><span>Show child attributes</span></div></div><div id="bkmrk-catalog_idstring%C2%B7req"><div><div>---

<div><div><span>catalog\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Product catalog ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>product\_retailer\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Product ID.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>referral</span><span>object</span></div><div><div><div><div><div><div><span><span>Only included if message via a Click to WhatsApp ad.</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-17"><div><span>Show child attributes</span></div></div><div id="bkmrk-source_urlstring%C2%B7req"><div><div>---

<div><div><span>source\_url</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Ad URL.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>source\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Ad ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>source\_type</span><span>One of "ad", "post"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>body</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Ad primary text.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>headline</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Ad headline.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>media\_type</span><span>One of "image", "video"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>image\_url</span><span>string</span></div><div><div><div><div><div><div><span><span>Only included for image media\_type.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>video\_url</span><span>string</span></div><div><div><div><div><div><div><span><span>Only included for video media\_type.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>thumbnail\_url</span><span>string</span></div><div><div><div><div><div><div><span><span>Only included for video media\_type.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>ctwa\_clid</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Ad click ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>welcome\_message</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-18"><div><span>Show child attributes</span></div></div><div id="bkmrk-textstring%C2%B7requireda"><div><div>---

<div><div><span>text</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Ad greeting text.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>ReactionMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-19"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-1"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"reaction"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>reaction</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-20"><div><span>Show child attributes</span></div></div><div id="bkmrk-message_idstring%C2%B7req"><div><div>---

<div><div><span>message\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp message ID of the message the WhatsApp user reacted to.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>emoji</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Emoji sent by the WhatsApp user as a reaction.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>AudioMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-21"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-2"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"audio"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>audio</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-22"><div><span>Show child attributes</span></div></div><div id="bkmrk-mime_typestring%C2%B7requ"><div><div>---

<div><div><span>mime\_type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset MIME type.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>sha256</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset SHA-256 hash.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset ID. A GET request on this ID can provide the asset URL.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>voice</span><span>boolean</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Boolean indicating if audio is a recording made with the WhatsApp client voice recording feature (true) or not (false).</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>DocumentMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-23"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-3"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"document"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>document</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-24"><div><span>Show child attributes</span></div></div><div id="bkmrk-mime_typestring%C2%B7requ-1"><div><div>---

<div><div><span>mime\_type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset MIME type.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>sha256</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset SHA-256 hash.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset ID. A GET request on this ID can provide the asset URL.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>filename</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset filename.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>ImageMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-25"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-4"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"image"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>image</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-26"><div><span>Show child attributes</span></div></div><div id="bkmrk-mime_typestring%C2%B7requ-2"><div><div>---

<div><div><span>mime\_type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset MIME type.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>sha256</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset SHA-256 hash.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset ID. A GET request on this ID can provide the asset URL.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>caption</span><span>string</span></div><div><div><div><div><div><div><span><span>Media asset caption text.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>StickerMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-27"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-5"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"sticker"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>sticker</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-28"><div><span>Show child attributes</span></div></div><div id="bkmrk-mime_typestring%C2%B7requ-3"><div><div>---

<div><div><span>mime\_type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset MIME type.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>sha256</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset SHA-256 hash.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset ID. A GET request on this ID can provide the asset URL.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>animated</span><span>boolean</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Boolean indicating if the sticker is animated (true) or not (false).</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>VideoMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-29"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-6"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"video"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>video</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-30"><div><span>Show child attributes</span></div></div><div id="bkmrk-mime_typestring%C2%B7requ-4"><div><div>---

<div><div><span>mime\_type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset MIME type.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>sha256</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset SHA-256 hash.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Media asset ID. A GET request on this ID can provide the asset URL.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>caption</span><span>string</span></div><div><div><div><div><div><div><span><span>Media asset caption text.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>LocationMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-31"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-7"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"location"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>location</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-32"><div><span>Show child attributes</span></div></div><div id="bkmrk-addressstring%C2%B7requir"><div><div>---

<div><div><span>address</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Location address.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>latitude</span><span>number (float)</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Location latitude.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>longitude</span><span>number (float)</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Location longitude.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>name</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Location name.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>url</span><span>string</span></div><div><div><div><div><div><div><span><span>Location URL. Usually only included for business locations.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>ContactSharingMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-33"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-8"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"contacts"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>contacts</span><span>array of ContactObject</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Array of contact objects. Many contact object properties may be omitted if the WhatsApp user chooses not to share them, or their device prevents them from being shared.</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-34"><div><span>Show child attributes</span></div></div><div id="bkmrk-contacts%5B%5Dobjectshow"><div><div>---

<div><div><span>contacts\[\]</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-35"><div><span>Show child attributes</span></div></div><div id="bkmrk-addressesarray-of-ob"><div><div>---

<div><div><span>addresses</span><span>array of object</span></div></div><div><div><div id="bkmrk-show-child-attribute-36"><div><span>Show child attributes</span></div></div><div id="bkmrk-addresses%5B%5Dobjectsho"><div><div>---

<div><div><span>addresses\[\]</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-37"><div><span>Show child attributes</span></div></div><div id="bkmrk-citystringcity-menti"><div><div>---

<div><div><span>city</span><span>string</span></div><div><div><div><div><div><div><span><span>City mentioned in the contact address</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>country</span><span>string</span></div><div><div><div><div><div><div><span><span>Country mentioned in the contact address</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-38"><div><span>Show child attributes</span></div></div><div id="bkmrk-country_codestringis"><div><div>---

<div><div><span>country\_code</span><span>string</span></div><div><div><div><div><div><div><span><span>ISO country code for the contact address</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>state</span><span>string</span></div><div><div><div><div><div><div><span><span>State mentioned in the contact address</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>street</span><span>string</span></div><div><div><div><div><div><div><span><span>Street mentioned in the contact address</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span></div><div><div><div><div><div><div><span><span>Type of address, such as home or work</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>zip</span><span>string</span></div><div><div><div><div><div><div><span><span>Zip code in the contact address</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>birthday</span><span>string (date)</span></div><div><div><div><div><div><div><span><span>Contact birthday (YYYY-MM-DD).</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>emails</span><span>array of object</span></div></div><div><div><div id="bkmrk-show-child-attribute-39"><div><span>Show child attributes</span></div></div><div id="bkmrk-emails%5B%5Dobjectshow-c"><div><div>---

<div><div><span>emails\[\]</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-40"><div><span>Show child attributes</span></div></div><div id="bkmrk-emailstring-%28email%29e"><div><div>---

<div><div><span>email</span><span>string (email)</span></div><div><div><div><div><div><div><span><span>Email address of the contact</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span></div><div><div><div><div><div><div><span><span>Type of email, such as personal or work</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>name</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-41"><div><span>Show child attributes</span></div></div><div id="bkmrk-formatted_namestring"><div><div>---

<div><div><span>formatted\_name</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Contact's formatted name</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>first\_name</span><span>string</span></div><div><div><div><div><div><div><span><span>Contact’s first name</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>last\_name</span><span>string</span></div><div><div><div><div><div><div><span><span>Contact’s last name</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>middle\_name</span><span>string</span></div><div><div><div><div><div><div><span><span>Contact’s middle name</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>suffix</span><span>string</span></div><div><div><div><div><div><div><span><span>Contact’s name suffix</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>prefix</span><span>string</span></div><div><div><div><div><div><div><span><span>Contact’s name prefix</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>org</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-42"><div><span>Show child attributes</span></div></div><div id="bkmrk-companystringname-of"><div><div>---

<div><div><span>company</span><span>string</span></div><div><div><div><div><div><div><span><span>Name of the company where the contact works</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>department</span><span>string</span></div><div><div><div><div><div><div><span><span>Name of the department where the contact works</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>title</span><span>string</span></div><div><div><div><div><div><div><span><span>Contact's job title</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>phones</span><span>array of object</span></div></div><div><div><div id="bkmrk-show-child-attribute-43"><div><span>Show child attributes</span></div></div><div id="bkmrk-phones%5B%5Dobjectshow-c"><div><div>---

<div><div><span>phones\[\]</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-44"><div><span>Show child attributes</span></div></div><div id="bkmrk-phonestringcontact%E2%80%99s"><div><div>---

<div><div><span>phone</span><span>string</span></div><div><div><div><div><div><div><span><span>Contact’s Phone number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>wa\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Contact's WhatsApp Number. Note that a WhatsApp user's ID and phone number may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span></div><div><div><div><div><div><div><span><span>Type of phone number. For example, cell, mobile, main, iPhone, home, work, etc.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>urls</span><span>array of object</span></div></div><div><div><div id="bkmrk-show-child-attribute-45"><div><span>Show child attributes</span></div></div><div id="bkmrk-urls%5B%5Dobjectshow-chi"><div><div>---

<div><div><span>urls\[\]</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-46"><div><span>Show child attributes</span></div></div><div id="bkmrk-urlstring-%28uri%29websi"><div><div>---

<div><div><span>url</span><span>string (uri)</span></div><div><div><div><div><div><div><span><span>Website URL associated with the contact or their company</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span></div><div><div><div><div><div><div><span><span>Type of website. For example, company, work, personal, Facebook Page, Instagram, etc.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>UnsupportedMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-47"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-9"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>One of "unsupported", "unknown"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>context</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-48"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredb-1"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business display phone number.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp message ID of the message containing the button the WhatsApp user tapped.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>button</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-49"><div><span>Show child attributes</span></div></div><div id="bkmrk-payloadstring%C2%B7requir"><div><div>---

<div><div><span>payload</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Quick-reply button payload.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>text</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Quick-reply button label text.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>ButtonMessage</span></div></div></div><div>---

<div><div><span>InteractiveMessageReply</span></div></div><div><div><div id="bkmrk-show-child-attribute-50"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-10"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"interactive"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>context</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-51"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredb-2"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business display phone number.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp message ID of the message containing the interactive component the user tapped.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>interactive</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-52"><div><span>Show child attributes</span></div></div><div id="bkmrk-typeone-of-%22list_rep"><div><div>---

<div><div><span>type</span><span>One of "list\_reply", "button\_reply"</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Type of interactive reply (list\_reply or button\_reply).</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>OrderMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-53"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-11"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"order"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>order</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-54"><div><span>Show child attributes</span></div></div><div id="bkmrk-catalog_idstring%C2%B7req-1"><div><div>---

<div><div><span>catalog\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Product catalog ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>text</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Empty string.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>product\_items</span><span>array of object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-55"><div><span>Show child attributes</span></div></div><div id="bkmrk-product_items%5B%5Dobjec"><div><div>---

<div><div><span>product\_items\[\]</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-56"><div><span>Show child attributes</span></div></div><div id="bkmrk-product_retailer_ids"><div><div>---

<div><div><span>product\_retailer\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Product ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>quantity</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Product quantity.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>item\_price</span><span>number (float)</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Individual product price.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>currency</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Catalog currency code.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>IncomingMessageValueSystem</span></div></div><div><div><div id="bkmrk-show-child-attribute-57"><div><span>Show child attributes</span></div></div><div id="bkmrk-messaging_productstr-1"><div><div>---

<div><div><span>messaging\_product</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Always 'whatsapp'.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>metadata</span><span>Metadata</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-58"><div><span>Show child attributes</span></div></div><div id="bkmrk-display_phone_number-1"><div><div>---

<div><div><span>display\_phone\_number</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business display phone number.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>phone\_number\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business phone number ID.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>messages</span><span>array of SystemMessage</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Array containing only 'system' message objects.</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-59"><div><span>Show child attributes</span></div></div><div id="bkmrk-messages%5B%5Dsystemmess"><div><div>---

<div><div><span>messages\[\]</span><span>SystemMessage</span></div></div><div><div><div id="bkmrk-show-child-attribute-60"><div><span>Show child attributes</span></div></div><div id="bkmrk-fromstring%C2%B7requiredw-12"><div><div>---

<div><div><span>from</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp indicating when the webhook was triggered.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"system"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>system</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-61"><div><span>Show child attributes</span></div></div><div id="bkmrk-bodystring%C2%B7requiredd"><div><div>---

<div><div><span>body</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Description of the system change (e.g., user changed number).</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>wa\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>New WhatsApp user ID.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>"user\_changed\_number"</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Type of system message.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>not</span><span>unknown</span></div></div></div></div></div></div></div></div><div>---

<div><div><span>StatusMessageValue</span></div></div><div><div><div id="bkmrk-show-child-attribute-62"><div><span>Show child attributes</span></div></div><div id="bkmrk-messaging_productstr-2"><div><div>---

<div><div><span>messaging\_product</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Always 'whatsapp'.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>metadata</span><span>Metadata</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-63"><div><span>Show child attributes</span></div></div><div id="bkmrk-display_phone_number-2"><div><div>---

<div><div><span>display\_phone\_number</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business display phone number.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>phone\_number\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business phone number ID.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>statuses</span><span>array of Statuses</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Array of status objects.</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-64"><div><span>Show child attributes</span></div></div><div id="bkmrk-statuses%5B%5Dstatusessh"><div><div>---

<div><div><span>statuses\[\]</span><span>Statuses</span></div></div><div><div><div id="bkmrk-show-child-attribute-65"><div><span>Show child attributes</span></div></div><div id="bkmrk-idstring%C2%B7requireduni"><div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique WhatsApp message ID the status is associated with.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>status</span><span>One of "sent", "delivered", "read", "failed"</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>timestamp</span><span>string</span><span>·</span><span>required</span></div></div></div><div>---

<div><div><span>recipient\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Recipeint phone number.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>group\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Group ID if the message was sent to a group.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>conversation</span><span>Conversation</span></div></div><div><div><div id="bkmrk-show-child-attribute-66"><div><span>Show child attributes</span></div></div><div id="bkmrk-idstringexpiration_t"><div><div>---

<div><div><span>id</span><span>string</span></div></div></div><div>---

<div><div><span>expiration\_timestamp</span><span>string</span></div></div></div><div>---

<div><div><span>origin</span><span>ConversationOrigin</span></div></div><div><div><div id="bkmrk-show-child-attribute-67"><div><span>Show child attributes</span></div></div><div id="bkmrk-typestring"><div><div>---

<div><div><span>type</span><span>string</span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>pricing</span><span>Pricing</span></div></div><div><div><div id="bkmrk-show-child-attribute-68"><div><span>Show child attributes</span></div></div><div id="bkmrk-billablebooleanprici"><div><div>---

<div><div><span>billable</span><span>boolean</span></div></div></div><div>---

<div><div><span>pricing\_model</span><span>One of "CBP", "PMP"</span></div></div></div><div>---

<div><div><span>category</span><span>string</span></div></div></div></div></div></div></div></div><div>---

<div><div><span>errors</span><span>array of StatusError</span></div></div><div><div><div id="bkmrk-show-child-attribute-69"><div><span>Show child attributes</span></div></div><div id="bkmrk-errors%5B%5Dstatuserrors"><div><div>---

<div><div><span>errors\[\]</span><span>StatusError</span></div></div><div><div><div id="bkmrk-show-child-attribute-70"><div><span>Show child attributes</span></div></div><div id="bkmrk-codeintegertitlestri"><div><div>---

<div><div><span>code</span><span>integer</span></div></div></div><div>---

<div><div><span>title</span><span>string</span></div></div></div><div>---

<div><div><span>message</span><span>string</span></div></div></div><div>---

<div><div><span>error\_data</span><span>ErrorData</span></div></div><div><div><div id="bkmrk-show-child-attribute-71"><div><span>Show child attributes</span></div></div><div id="bkmrk-detailsstring"><div><div>---

<div><div><span>details</span><span>string</span></div></div></div></div></div></div></div></div><div>---

<div><div><span>href</span><span>string</span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>GroupValue</span></div></div><div><div><div id="bkmrk-show-child-attribute-72"><div><span>Show child attributes</span></div></div><div id="bkmrk-messaging_productstr-3"><div><div>---

<div><div><span>messaging\_product</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Always 'whatsapp'.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>metadata</span><span>Metadata</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-73"><div><span>Show child attributes</span></div></div><div id="bkmrk-display_phone_number-3"><div><div>---

<div><div><span>display\_phone\_number</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business display phone number.</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>phone\_number\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business phone number ID.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>groups</span><span>array of Groups</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Array of group objects.</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-74"><div><span>Show child attributes</span></div></div><div id="bkmrk-groups%5B%5Dgroupsshow-c"><div><div>---

<div><div><span>groups\[\]</span><span>Groups</span></div></div><div><div><div id="bkmrk-show-child-attribute-75"><div><span>Show child attributes</span></div></div><div id="bkmrk-timestampinteger%C2%B7req"><div><div>---

<div><div><span>timestamp</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unix timestamp of the group event</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>group\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique identifier for the group</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>One of "group\_create", "group\_delete", "group\_settings\_update", "group\_add\_participants", "group\_remove\_participants"</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Type of group event</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>request\_id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique identifier for the request</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>subject</span><span>string</span></div><div><div><div><div><div><div><span><span>Group subject/name</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>description</span><span>string</span></div><div><div><div><div><div><div><span><span>Group description</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>added\_participants</span><span>array of GroupParticipant</span></div><div><div><div><div><div><div><span><span>List of participants added to the group</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-76"><div><span>Show child attributes</span></div></div><div id="bkmrk-added_participants%5B%5D"><div><div>---

<div><div><span>added\_participants\[\]</span><span>GroupParticipant</span></div></div><div><div><div id="bkmrk-show-child-attribute-77"><div><span>Show child attributes</span></div></div><div id="bkmrk-inputstringinput-pho"><div><div>---

<div><div><span>input</span><span>string</span></div><div><div><div><div><div><div><span><span>Input phone number or WhatsApp ID</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>wa\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>WhatsApp ID of the participant</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>removed\_participants</span><span>array of GroupParticipant</span></div><div><div><div><div><div><div><span><span>List of participants removed from the group</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-78"><div><span>Show child attributes</span></div></div><div id="bkmrk-removed_participants"><div><div>---

<div><div><span>removed\_participants\[\]</span><span>GroupParticipant</span></div></div><div><div><div id="bkmrk-show-child-attribute-79"><div><span>Show child attributes</span></div></div><div id="bkmrk-inputstringinput-pho-1"><div><div>---

<div><div><span>input</span><span>string</span></div><div><div><div><div><div><div><span><span>Input phone number or WhatsApp ID</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>wa\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>WhatsApp ID of the participant</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>profile\_picture</span><span>GroupProfilePicture</span></div></div><div><div><div id="bkmrk-show-child-attribute-80"><div><span>Show child attributes</span></div></div><div id="bkmrk-mime_typestringmime-"><div><div>---

<div><div><span>mime\_type</span><span>string</span></div><div><div><div><div><div><div><span><span>MIME type of the profile picture</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>sha256</span><span>string</span></div><div><div><div><div><div><div><span><span>SHA256 hash of the profile picture</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>field</span><span>One of "messages", "group\_lifecycle\_update", "group\_settings\_update", "group\_participant\_update"</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>The field indicate to what object is the webhook related:</span></span></div></div><div><span><span>messages: the webhook is related to messages from consumer or status of message sent by business to consumer.</span></span></div><div><span><span>group\_lifecycle\_update: the webhook is related to group creation and deletion.</span></span></div><div><span><span>group\_settings\_update: the webhook is related to group settings update.</span></span></div><div><span><span>group\_participant\_update: the webhook is related to participants joining and leaving the groups.</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>Responses</span>---

<div><div><div><div><div><div><span><span>Endpoint for receiving webhook payloads for diverse incoming WhatsApp message types.</span></span></div></div></div></div></div></div><div><span>200</span><div><div><div><div><div><div><span><span>Webhook received successfully</span></span></div></div></div></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div></div></div></div></div></div><div><div id="bkmrk-authentication"><div id="bkmrk-authentication-1"><div>### Authentication

</div></div></div><div><table><tbody><tr><td><div>**Scheme**</div></td><td><div>**Type**</div></td><td><div>**Location**</div></td></tr><tr><td><div><div><div><div><div><div><div><span><span>bearerAuth</span></span></div></div></div></div></div></div></div></td><td><div><div><div><div><div><div><div><span><span>HTTP Bearer</span></span></div></div></div></div></div></div></div></td><td><div><div><div><div><div><div><div><span><span>Header: </span></span>`<span><span>Authorization</span></span>`</div></div></div></div></div></div></div></td></tr></tbody></table>

</div><div>#### Usage Examples

<div><span>bearerAuth:</span><div><div><div><div><div><div><span><span>Include </span></span>`<span><span>Authorization: Bearer your-token-here</span></span>`<span><span> in request headers</span></span></div></div></div></div></div></div></div></div><div>#### Global Authentication Requirements

<div><span>All endpoints require:</span><div><div><div><div><div><div><span><span>bearerAuth</span></span></div></div></div></div></div></div></div></div></div></div>