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.

Common Event Attributes

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.

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

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

{
  "eventCategoryType": "EngagementEvents.EmailOpen",
  "timestampUTC": 1600722902000,
  "compositeId": "2001071.44609.4119.135804581",
  "definitionKey": "NA",
  "definitionId": "NA",
  "channel": "email",
  "mid": 1447640,
  "eid": 1447640,
  "composite": {
    "jobId": "2001071",
    "batchId": "4119",
    "listId": "44609",
    "subscriberId": "135804581"
  },
  "info": {
    "ipAddress": "52.5.174.125",
    "userAgent": "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1",
    "location": {}
  }
}

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

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.

EngagementEvents.EmailClick Payload Example

{
  "eventCategoryType": "EngagementEvents.EmailClick",
  "timestampUTC": 1591407815000,
  "compositeId": "1722201.69238.15596.177361590",
  "definitionKey": "NA",
  "definitionId": "NA",
  "channel": "email",
  "mid": 1476456,
  "eid": 1476266,
  "composite": {
    "jobId": "1722201",
    "batchId": "15596",
    "listId": "69238",
    "subscriberId": "177361590"
  },
  "info": {
    "ipAddress": "52.5.174.125",
    "jobUrlId": "74165311",
    "contentLink": "https://portal.makanahealth.com/memberID\u003d?18937918018\u0026cm_ven\u003dExactTarget\u0026cm_cat\u003dMakana+Member+Notifications\u0026cm_pla\u003dAll+Subscribers\u0026cm_ite\u003dhttps%3a%2f%2fportal.makanahealth.com%2fmemberID%3d%3f18937918018\u0026cm_lm\u003ddfallon.10064.0401@gmail.exacttargettest.com\u0026cm_ainfo\u003d\u0026att1\u003d\u0026att2\u003d%%__AdditionalEmailAttribute2%%\u0026att3\u003d%%__AdditionalEmailAttribute3%%\u0026att4\u003d%%__AdditionalEmailAttribute4%%\u0026att5\u003d%%__AdditionalEmailAttribute5%%",
    "impressionRegion": "0",
    "userAgent": "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; WOW64; Trident/4.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; InfoPath.2; AskTB5.5; MSOffice 12)",
    "location": {
      "country": "US",
      "region": "VA",
      "city": "ASHBURN",
      "postalCode": "20146-20149",
      "latitude": "39.0438",
      "longitude": "-77.4879"
    }
  }
}

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

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`.

EngagementEvents.EmailUnsubscribe Payload Example

{
  "eventCategoryType": "EngagementEvents.EmailUnsubscribe",
  "timestampUTC": 1591407815000,
  "compositeId": "1722201.69238.15607.178363503",
  "definitionKey": "NA",
  "definitionId": "NA",
  "mid": 1476456,
  "eid": 1476266,
  "composite": {
    "jobId": "1722201",
    "batchId": "15607",
    "listId": "69238",
    "subscriberId": "178363503"
  },
  "info": {
    "to": "pventura.10047.0953@gmail.exacttargettest.com",
    "domain": "gmail.exacttargettest.com",
    "unsubscribeDate": 1591386215000,
    "unsubscribeMethod": "Click"
  }
}