Engagement OTT Delivery Receipt Events
The Event Notification Service supports these event notification types and their corresponding payloads.
The events are supported only for WhatsApp Direct (Meta) sends using the Transactional API.
| Notification Event Category | Notification Event Type | Description |
|---|---|---|
| EngagementEvents | OttSent | Indicates that Meta has sent the OTT message to the user device. |
| EngagementEvents | OttDelivered | Indicates that the OTT message was delivered to the user device. |
| EngagementEvents | OttRead | Indicates that the user has read the OTT message. |
| EngagementEvents | OttFailed | Indicates that Meta failed to send the OTT message to the user device. |
These are the common attributes for delivery receipt events.
| Attribute | Type | Description |
|---|---|---|
| EventType | string | The type of event. The values are EngagementEvents.OttSent, EngagementEvents.OttDelivered, EngagementEvents.OttRead, and EngagementEvents.OttFailed. |
| MID | string | Tenant Business Unit ID from which the event was produced |
| EID | string | Tenant Enterprise ID from which the event was produced |
| SenderType | string | The type of sender. For example, WhatsApp, LINE and so on. Currently, the only supported value is WhatsApp. |
| SenderID | string | The ID of the channel from which the message was sent to the subscriber. |
| MessageKey | string | The message key that was generated during the transactional send request. |
| TimeStamp | number | UTC epoch time |
| Reason | string | Reason for failure from Meta. For more information, see Meta error codes. The Reason attribute is optional and is available only for a failed event. |