Supported Notification Events
The Event Notification Service supports these event notification types and their corresponding payloads.
| Notification Event Category | Notification Event Type | Description |
|---|---|---|
| TransactionalSendEvents | EmailSent | Indicates that the email was sent to the email provider. |
| TransactionalSendEvents | EmailNotSent | Indicates that the email was not sent and includes the reason. |
| TransactionalSendEvents | EmailBounced | Indicates that the email bounced and includes the reason. |
| EngagementEvents | EmailOpen | Indicates that the email was opened. |
| EngagementEvents | EmailClick | Indicates that the recipient clicked a link in the email. |
| EngagementEvents | EmailUnsubscribe | Indicates that the recipient clicked the unsubscribe link in the email. |
| TransactionalSendEvents | SmsSent | Indicates that the SMS message was sent to the aggregator. |
| TransactionalSendEvents | SmsNotSent | Indicates that the SMS message was not sent and includes the reason. |
| TransactionalSendEvents | SmsTransient | Indicates 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. |
| TransactionalSendEvents | SmsBounced | Indicates that the SMS message bounced and includes the reason. |
| TransactionalSendEvents | SmsDelivered | Indicates that the SMS message was delivered. |
All or some of these attributes are shared for all event data payloads.
| Attribute | Type | Description |
|---|---|---|
| eventCategoryType | string | The taxonomy of the event |
| timestampUTC | number | UTC Epoch time |
| compositeId | string | Internal tracking ID (deprecated) |
| composite | object | Object containing broken down composite ID |
| composite.jobId | string | Marketing Cloud Job ID |
| composite.batchId | string | Marketing Cloud Batch ID |
| composite.listId | string | Marketing Cloud List ID |
| definitionKey | string | Send Definition Customer Key (Transactional Sent Events Only) |
| definitionId | string | Send Definition Id (Transactional Sent Events Only) |
| mid | number | Tenant Business Unit Id event was produced from |
| eid | number | Tenant Enterprise Id event was produced from |
| info | object | Object containing event-specific details |
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailSent event.
Email Sent Info Attributes
| Attribute | Type | Description |
|---|---|---|
| to | string | Tenant Business Id event was produced from |
| subscriberKey | string | Tenant Enterprise Id event was produced from |
| messageKey | string | Object containing event-specific details |
| status | string | Result of the Sent Event |
| renderedSubject | string | The subject line after personalization |
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailNotSent event.
Email Not Sent Info Attributes
| Attribute | Type | Description |
|---|---|---|
| to | string | Tenant Business Id event was produced from |
| subscriberKey | string | Tenant Enterprise Id event was produced from |
| messageKey | string | Object containing event-specific details |
| reason | string | The descriptive reason |
| statusCode | string | The subscriber error code |
| statusMessage | string | The subscriber error message |
TransactionalSendEvents.EmailNotSent Payload Example
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailBounced event.
Email Bounce Info Attributes
| Attribute | Type | Description |
|---|---|---|
| to | string | Tenant Business Id event was produced from |
| subscriberKey | string | Tenant Enterprise Id event was produced from |
| messageKey | string | Object containing event-specific details |
| bounceCode | string | The type of bounce - "HARD" or "SOFT" |
| bounceMessage | string | The string from the recipient email send the provider |
| smtpReason | string | The error value of the SMTP reason |
TransactionalSendEvents.EmailBounced Payload Example
This event notification payload is an example of what your callback receives for an EngagementEvents.EmailOpen event.
Email Open Info Attributes
| Attribute | Type | Description |
|---|---|---|
| ipAddress | string | IP address detected from click source |
| userAgent | string | User agent from click source |
| location | object | Contains information about location based on IP address. If the location was unable to be detected, this object will be empty |
EngagementEvents.EmailOpen Payload Example
This event notification payload is an example of what your callback receives for an EngagementEvents.EmailClick event.
Email Click Info Attributes
| Attribute | Type | Description |
|---|---|---|
| ipAddress | string | IP address detected from click source |
| jobUrlId | string | Marketing Cloud internal job location |
| contentLink | string | Object containing event-specific details |
| impressionRegion | string | Result of the Sent Event |
| userAgent | string | User agent from click source |
| location | object | Contains information about location based on IP address. If location was unable to be detected, this object will be empty |
| location.country | string | Country for the Location object. |
| location.region | string | Region for the Location object. |
| location.city | string | City for the Location object. |
| location.postalCode | string | Postal code for the Location object. |
| location.latitude | string | Latitude coordinates for the Location object. |
| location.longitude | string | Longitude coordinates for the Location object. |
EngagementEvents.EmailClick Payload Example
This event notification payload is an example of what your callback receives for an EngagementEvents.EmailUnsubscribe event.
Email Unsubscribe Info Attributes
| Attribute | Type | Description |
|---|---|---|
| to | string | Tenant Business Id event was produced from |
| domain | string | email domain of event |
| unsubscribeDate | number | The date the subscriber unsubscribed |
| unsubscribeMethod | string | How the unsubscribe occurred; click,reply |
| renderedSubject | string | The subject line after personalization |
EngagementEvents.EmailUnsubscribe Payload Example
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsSent event.
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsNotSent event.
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsTransient event.
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsDelivered event.
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsBounced event.