Supported Notification Events

The Event Notification Service supports these event notification types and their corresponding payloads.

Notification Event CategoryNotification Event TypeDescription
TransactionalSendEventsEmailSentIndicates that the email was sent to the email provider.
TransactionalSendEventsEmailNotSentIndicates that the email was not sent and includes the reason.
TransactionalSendEventsEmailBouncedIndicates that the email bounced and includes the reason.
EngagementEventsEmailOpenIndicates that the email was opened.
EngagementEventsEmailClickIndicates that the recipient clicked a link in the email.
EngagementEventsEmailUnsubscribeIndicates that the recipient clicked the unsubscribe link in the email.
TransactionalSendEventsSmsSentIndicates that the SMS message was sent to the aggregator.
TransactionalSendEventsSmsNotSentIndicates that the SMS message was not sent and includes the reason.
TransactionalSendEventsSmsTransientIndicates the most recent transmission status between Salesforce and the mobile device. Not the final disposition. This information is provided by our delivery partners and mobile carriers but is not available in all locales. No actions to take.
TransactionalSendEventsSmsBouncedIndicates that the SMS message bounced and includes the reason.
TransactionalSendEventsSmsDeliveredIndicates that the SMS message was delivered.

Common Event Attributes

All or some of these attributes are shared for all event data payloads.

AttributeTypeDescription
eventCategoryTypestringThe taxonomy of the event
timestampUTCnumberUTC Epoch time
compositeIdstringInternal tracking ID (deprecated)
compositeobjectObject containing broken down composite ID
composite.jobIdstringMarketing Cloud Job ID
composite.batchIdstringMarketing Cloud Batch ID
composite.listIdstringMarketing Cloud List ID
definitionKeystringSend Definition Customer Key (Transactional Sent Events Only)
definitionIdstringSend Definition Id (Transactional Sent Events Only)
midnumberTenant Business Unit Id event was produced from
eidnumberTenant Enterprise Id event was produced from
infoobjectObject containing event-specific details

Transactional Email Sent Event

This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailSent event.

Email Sent Info Attributes

AttributeTypeDescription
tostringTenant Business Id event was produced from
subscriberKeystringTenant Enterprise Id event was produced from
messageKeystringObject containing event-specific details
statusstringResult of the Sent Event
renderedSubjectstringThe subject line after personalization

Transactional Email Sent Payload Example

Transactional Email Not Sent Event

This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailNotSent event.

Email Not Sent Info Attributes

AttributeTypeDescription
tostringTenant Business Id event was produced from
subscriberKeystringTenant Enterprise Id event was produced from
messageKeystringObject containing event-specific details
reasonstringThe descriptive reason
statusCodestringThe subscriber error code
statusMessagestringThe subscriber error message

TransactionalSendEvents.EmailNotSent Payload Example

Transactional Email Bounced Event

This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailBounced event.

Email Bounce Info Attributes

AttributeTypeDescription
tostringTenant Business Id event was produced from
subscriberKeystringTenant Enterprise Id event was produced from
messageKeystringObject containing event-specific details
bounceCodestringThe type of bounce - "HARD" or "SOFT"
bounceMessagestringThe string from the recipient email send the provider
smtpReasonstringThe error value of the SMTP reason

TransactionalSendEvents.EmailBounced Payload Example

Engagement Event Email Open

This event notification payload is an example of what your callback receives for an EngagementEvents.EmailOpen event.

Email Open Info Attributes

AttributeTypeDescription
ipAddressstringIP address detected from click source
userAgentstringUser agent from click source
locationobjectContains information about location based on IP address. If the location was unable to be detected, this object will be empty

EngagementEvents.EmailOpen Payload Example

Engagement Event Email Click

This event notification payload is an example of what your callback receives for an EngagementEvents.EmailClick event.

Email Click Info Attributes

AttributeTypeDescription
ipAddressstringIP address detected from click source
jobUrlIdstringMarketing Cloud internal job location
contentLinkstringObject containing event-specific details
impressionRegionstringResult of the Sent Event
userAgentstringUser agent from click source
locationobjectContains information about location based on IP address. If location was unable to be detected, this object will be empty
location.countrystringCountry for the Location object.
location.regionstringRegion for the Location object.
location.citystringCity for the Location object.
location.postalCodestringPostal code for the Location object.
location.latitudestringLatitude coordinates for the Location object.
location.longitudestringLongitude coordinates for the Location object.

EngagementEvents.EmailClick Payload Example

Engagement Event Email Unsubscribe

This event notification payload is an example of what your callback receives for an EngagementEvents.EmailUnsubscribe event.

Email Unsubscribe Info Attributes

AttributeTypeDescription
tostringTenant Business Id event was produced from
domainstringemail domain of event
unsubscribeDatenumberThe date the subscriber unsubscribed
unsubscribeMethodstringHow the unsubscribe occurred; click,reply
renderedSubjectstringThe subject line after personalization

EngagementEvents.EmailUnsubscribe Payload Example

Transactional SMS Sent Event Payload Example

This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsSent event.

Transactional SMS Not Sent Event Payload Example

This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsNotSent event.

Transactional SMS Transient Event Payload Example

This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsTransient event.

Transactional SMS Delivered Event Payload Example

This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsDelivered event.

Transactional SMS Bounced Event Payload Example

This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsBounced event.