WhatsApp Send Events
The Event Notification Service supports these event notification types and their corresponding payloads for WhatsApp messaging.
Notification Event Category | Notification Event Type | Description |
---|---|---|
SendEvents | OttNotSent | Indicates that the message wasn’t sent to Meta, or Meta didn’t accept the request to send this message. ENS sends this notification type for messages sent that don’t originate from the Transactional API, such as those sent from journeys. |
TransactionalSendEvents | OttNotSent | Indicates that the message wasn’t sent to Meta, or Meta didn’t accept the request to send the message. ENS sends this notification type only for messages sent by using the Transactional API. |
ENS produces an OttNotSent
notification if a WhatApp message isn't sent. OttNotSent
notifications can have 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 . |
channelId | string | The sender ID, such as a phone number, used to send the message to the subscriber. |
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 Business Unit ID of the account that produced the event. |
eventCategoryType | string | The type of the event. Possible values are TransactionalSendEvents.OttNotSent and SendEvents.OttNotSent . |
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 Enterprise ID of the account that produced the event. |
mobileNumber | string | The subscriber’s phone number. |
reason | string | Reason for failure from Meta. For more information, see Meta error codes. |
senderType | string | The app used to send the message. The only supported value is WhatsApp . |
sendType | string | The type of send. Possible values are TransactionalSend and JourneyBuilder . |
status | string | The status of the message. Possible values are NOTSENT and Unknown . |
timestampUTC | number | The date and time when the message was sent, shown as a UTC epoch timestamp. |
This example shows a not sent event notification for a transactional WhatsApp message.
This example shows a not sent event notification for a WhatsApp message sent from a journey.