Configure WebHook

When there are message updates in Waba, update events are pushed to customers via Webhook. These include message status updates, user reply messages, Waba account review status updates, WhatsApp template status updates, sender display name changes, and more.

Configure WebHook Events

When pushing events such as templates and inbound replies, if the App cannot be identified or matched, the data will be pushed to the default application; if there is no default application, it will not be pushed.

1. In the API Keys function menu list, click the callback event configuration button to start configuration

2. Click the [Add] button to add

3. Select the product for which you need to configure WebHook from the available product list

4. Configure the callback URL, select the events to receive, and click Next to proceed

5. Select the callback request method, default is POST. If the customer's business system needs to verify the source of the WebHook, UserName and Authorization header information can be configured. When WebHook notification is pushed, UserName and Authorization will be added to the header information, and the customer's configured information will be pushed together to the customer's system.

WebHook Common Parameters

Field	Data Type	Required	Description
id	String	Yes	File handle, identifier
type	String	Yes	Event type:whatsapp_message_status_updated: Message status report (available) whatsapp_mo_message_received: Inbound message (available)whatsapp_template_status_updated: Template status update (available) whatsapp_account_review_updated: Account review status update (updating) whatsapp_phone_number_name_update: Sending number name update (updating)
eventTime	String	Yes	Event time, e.g.: 2023-02-22 12:00:00
body	JSON	Yes	Message body