Configure WebHook

When the Waba has message updates, it will push update events to customers via Webhook. This includes message status updates, user reply messages, Waba account audit status updates, WhatsApp template status updates, sender display name changes for sending numbers, etc.

Configure WebHook events

When pushing events such as template pushes or incoming 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 feature menu list, click the callback event configuration button to start configuring

2. Click the [Add] button to add

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

4. Configure the callback URL and select the events you need to receive, then 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, you can configure UserName and Authorization header information. When the WebHook notification is pushed, UserName and Authorization will be added to the headers and the customer's configured information will be pushed to the customer's system.

WebHook common parameters

Field

Data type

Required

Description

id

String

Yes

file handle, marker

type

String

Yes

event type:whatsapp_message_status_updated: message status report (available) whatsapp_mo_message_received: incoming message (available)whatsapp_template_status_updated: template status updated (available) whatsapp_account_review_updated: account review status updated (updating) whatsapp_phone_number_name_update: sending number name updated (updating)

eventTime

String

Yes

Event time, e.g.: 2023-02-22 12:00:00

body

JSON

Yes

message body

Last updated