Engagement Email Events
The Event Notification Service supports these event notification types and their corresponding payloads.
| Notification Event Category | Notification Event Type | Description |
|---|---|---|
| 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. |
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 an EngagementEvents.EmailOpen event.
| 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 |
This event notification payload is an example of what your callback receives for an EngagementEvents.EmailClick event.
| 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. |
This event notification payload is an example of what your callback receives for an EngagementEvents.EmailUnsubscribe event.
| 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 |