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 | An internal tracking ID. |
| composite | object | Object containing broken down composite ID. |
| composite.jobId | string | A unique job ID. |
| composite.batchId | string | A unique batch ID. |
| composite.listId | string | A unique list ID. |
| definitionKey | string | Send definition customer key. Used only with transactional send events. |
| definitionId | string | Send definition ID. Used only with transactional send events. |
| mid | number | The ID of the business unit that produced the event. |
| eid | number | The enterprise ID. |
| info | object | An object that contains details of the event. |
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 the click source. |
| jobUrlId | string | The internal job location. |
| contentLink | string | An object that contains details of the event. |
| impressionRegion | string | Result of the sent event. |
| userAgent | string | User agent from click source. |
| location | object | An object that contains information about location based on the IP address. If the location can't be determined, this object is 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 | The ID of the org that produced the event. |
| domain | string | The email domain associated with the event. |
| unsubscribeDate | number | The date the subscriber unsubscribed. |
| unsubscribeMethod | string | How the unsubscribe occurred. Possible values are click and reply. |
| renderedSubject | string | The subject line. This value includes all personalization elements. |