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 Event Attributes

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: `JourneyBuilder`: Messages sent from a journey activity. `Transactional`: Messages sent using the Transactional API. `Inbound`: Messages sent as a default response to a Mobile Originated message.
`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.

Sent Event Examples

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.

Transactional Message Sent Event Receipt

This example shows a sent event notification for a transactional WhatsApp message.

1[
2  {
3    "eventCategoryType": "EngagementEvents.OttSent",
4    "eid": 1982,
5    "mid": 2507,
6    "senderType": "WhatsApp",
7    "senderId": "9988776655",
8    "messageKey": "uHi8JOr630KHAJ5tuplsqg",
9    "timestampUTC": 1706018114,
10    "sendMethod": "TransactionalSend",
11    "contactKey": "ContactExample",
12    "mobileNumber": "99999999999"
13  }
14]

Journey Message Sent Event Receipt

This example shows a sent event notification for a WhatsApp message sent from a journey.

1[
2  {
3    "eventCategoryType": "EngagementEvents.OttSent",
4    "eid": 1982,
5    "mid": 2507,
6    "senderType": "WhatsApp",
7    "senderId": "9988776655",
8    "messageKey": "uHi8JOr630KHAJ5tuplsqg",
9    "timestampUTC": 1706018114,
10    "sendMethod": "JourneyBuilder",
11    "contactKey": "ContactExample",
12    "mobileNumber": "99999999999",
13    "journeyId": "b2fca3b5-5bce-44ce-8e6a-cc852d247ed5",
14    "activityId": "00b375bd-51f9-470a-a87b-0a1fc8919000",
15    "journeyName": "ExampleJourneyName",
16    "journeyVersion": 1,
17    "activityName": "ExampleActivityName"
18  }
19]

Delivered Event Examples

These examples show the payload format for delivered event notifications from Event Notification Service.

Transactional Message Delivered Event Receipt

This example shows a delivered event notification for a transactional WhatsApp message.

1[
2  {
3    "eventCategoryType": "EngagementEvents.OttDelivered",
4    "eid": 1982,
5    "mid": 2507,
6    "senderType": "WhatsApp",
7    "senderId": "9988776655",
8    "messageKey": "uHi8JOr630KHAJ5tuplsqg",
9    "timestampUTC": 1706109047,
10    "sendMethod": "TransactionalSend",
11    "contactKey": "ContactExample",
12    "mobileNumber": "99999999999"
13  }
14]

Journey Message Delivered Event Receipt

This example shows a delivered event notification for a WhatsApp message sent from a journey.

1[
2  {
3    "eventCategoryType": "EngagementEvents.OttDelivered",
4    "eid": 1982,
5    "mid": 2507,
6    "senderType": "WhatsApp",
7    "senderId": "9988776655",
8    "timestampUTC": 1706109047,
9    "sendMethod": "JourneyBuilder",
10    "contactKey": "ContactExample",
11    "mobileNumber": "99999999999",
12    "journeyId": "b2fca3b5-5bce-44ce-8e6a-cc852d247ed5",
13    "activityId": "00b375bd-51f9-470a-a87b-0a1fc8919000",
14    "journeyName": "ExampleJourneyName",
15    "journeyVersion": 1,
16    "activityName": "ExampleActivityName"
17  }
18]

Read Event Examples

These examples show the payload format for read event notifications from Event Notification Service.

Transactional Message Read Event Receipt

This example shows a read event notification for a transactional WhatsApp message.

1[
2  {
3    "eventCategoryType": "EngagementEvents.OttRead",
4    "eid": 1982,
5    "mid": 2507,
6    "senderType": "WhatsApp",
7    "senderId": "9988776655",
8    "messageKey": "uHi8JOr630KHAJ5tuplsqg",
9    "timestampUTC": 1706018253,
10    "sendMethod": "TransactionalSend",
11    "contactKey": "ContactExample",
12    "mobileNumber": "99999999999"
13  }
14]

Journey Message Read Event Receipt

This example shows a read event notification for a WhatsApp message sent from a journey.

1[
2  {
3    "eventCategoryType": "EngagementEvents.OttRead",
4    "eid": 1982,
5    "mid": 2507,
6    "senderType": "WhatsApp",
7    "senderId": "9988776655",
8    "timestampUTC": 1706018253,
9    "sendMethod": "JourneyBuilder",
10    "contactKey": "ContactExample",
11    "mobileNumber": "99999999999",
12    "journeyId": "b2fca3b5-5bce-44ce-8e6a-cc852d247ed5",
13    "activityId": "00b375bd-51f9-470a-a87b-0a1fc8919000",
14    "journeyName": "ExampleJourneyName",
15    "journeyVersion": 1,
16    "activityName": "ExampleActivityName"
17  }
18]

Failed Event Examples

These examples show the payload format for failed event notifications from Event Notification Service.

Transactional Message Failed Event Receipt

This example shows a failed event notification for a transactional WhatsApp message.

1[
2  {
3    "eventCategoryType": "EngagementEvents.OttFailed",
4    "eid": 1982,
5    "mid": 2507,
6    "senderType": "WhatsApp",
7    "senderId": "9988776655",
8    "messageKey": "uHi8JOr630KHAJ5tuplsqg",
9    "reason": "131026 Message Undeliverable",
10    "timestampUTC": 1706018186,
11    "sendMethod": "TransactionalSend",
12    "contactKey": "ContactExample",
13    "mobileNumber": "99999999999"
14  }
15]

Journey Message Failed Event Receipt

This example shows a failed event notification for a WhatsApp message sent from a journey.

1[
2  {
3    "eventCategoryType": "EngagementEvents.OttFailed",
4    "eid": 1982,
5    "mid": 2507,
6    "senderType": "WhatsApp",
7    "senderId": "9988776655",
8    "messageKey": "uHi8JOr630KHAJ5tuplsqg",
9    "reason": "131026 Message Undeliverable",
10    "timestampUTC": 1706018186,
11    "sendMethod": "JourneyBuilder",
12    "contactKey": "ContactExample",
13    "mobileNumber": "99999999999",
14    "journeyId": "b2fca3b5-5bce-44ce-8e6a-cc852d247ed5",
15    "activityId": "00b375bd-51f9-470a-a87b-0a1fc8919000",
16    "journeyName": "ExampleJourneyName",
17    "journeyVersion": 1,
18    "activityName": "ExampleActivityName"
19  }
20]