WhatsApp Delivery Receipt Events
The Event Notification Service supports these event notification types and their corresponding payloads for WhatsApp messages.
| Notification Event Category | Notification Event Type | Description |
|---|---|---|
EngagementEvents | OttDelivered | Indicates that the message was delivered to the user device. |
EngagementEvents | OttFailed | Indicates that Meta failed to send the message to the user’s device. |
EngagementEvents | OttRead | Indicates that the user has read the message. |
EngagementEvents | OttSent | Indicates that Meta sent the message to the user’s device. |
Delivery receipt events can include the attributes listed in this table.
| Attribute | Type | Description |
|---|---|---|
activityId | string | Unique ID for the Journey Builder activity that sent this message. Delivery receipts include this attribute only if the value of sendMethod is JourneyBuilder. |
activityName | string | The name of the journey activity that sent the message. Delivery receipts include this attribute only if the value of sendMethod is JourneyBuilder. |
contactKey | string | If the contact information for the transactional message matches a subscriber in Marketing Cloud Engagement, this field contains the subscriber key. |
eid | string | The Enterprise ID of the account that produced the event. |
eventCategoryType | string | The type of event. Possible values are EngagementEvents.OttSent, EngagementEvents.OttDelivered, EngagementEvents.OttRead, and EngagementEvents.OttFailed. |
journeyId | string | The unique ID of the journey that sent the message. Delivery receipts include this attribute only if the value of sendMethod is JourneyBuilder. |
journeyName | string | The name of the journey that sent the message. Delivery receipts include this attribute only if the value of sendMethod is JourneyBuilder. |
journeyVersion | number | The version number of the journey sent the message. Delivery receipts include this attribute only if the value of sendMethod is JourneyBuilder. |
messageKey | string | A unique message key generated during the transactional send request. Delivery receipts include this attribute only for transactional send events. |
mid | string | The Business Unit ID of the account that produced the event. |
mobileNumber | string | The subscriber's phone number. |
reason | string | The reason that a message wasn't delivered. This message is provided by Meta. Delivery receipts include this attribute only for transactional messages that failed. See WhatsApp Cloud API Documentation: Cloud API error codes. |
sendMethod | string | The method used to send the message. Possible values:
|
senderID | string | The sender ID, such as a phone number, used to send the message to the subscriber. |
senderType | string | The app used to send the message. The only possible value is WhatsApp. |
timestampUTC | number | The date and time when the message was sent, shown as a UTC epoch timestamp. |
These examples show the payload format for sent event notifications from Event Notification Service. The examples demonstrate the differences in payload attributes between transactional messages and journey messages.
This example shows a sent event notification for a transactional WhatsApp message.
This example shows a sent event notification for a WhatsApp message sent from a journey.
These examples show the payload format for delivered event notifications from Event Notification Service.
This example shows a delivered event notification for a transactional WhatsApp message.
This example shows a delivered event notification for a WhatsApp message sent from a journey.
These examples show the payload format for read event notifications from Event Notification Service.
This example shows a read event notification for a transactional WhatsApp message.
This example shows a read event notification for a WhatsApp message sent from a journey.
These examples show the payload format for failed event notifications from Event Notification Service.
This example shows a failed event notification for a transactional WhatsApp message.
This example shows a failed event notification for a WhatsApp message sent from a journey.