Page events - EXM
For background information on page events, see the Page events page.
Common email event mappings
All email events described on this page include the following mappings:
| Value to write to event object | Property on event object |
|---|---|
Constant value 1 | EmailAddressHistoryEntryId |
MessageId from CustomValues from source object | InstanceId |
ManagerRootId from CustomValues from source object | ManagerRootId |
MessageId from CustomValues from source object | MessageId |
MessageLanguage from CustomValues from source object | MessageLanguage |
TestValueIndex from CustomValues from source object | TestValueIndex |
DateTime from source object | Timestamp |
Bounce events
This section describes how bounce events are mapped from Sitecore 8.x to 9.
| Source object | Member of the array located at PageEvents on the page from the interaction |
| Event mapping definition | Event Mappings for MongoDB Page Events > Bounce Event |
| Event object type | Sitecore.EmailCampaign.Model.XConnect.Events.BounceEvent |
| Conditions | PageEventDefinitionId on source object is {F7E054F5-6F73-4C09-82B0-9F36141BE42F} |
| Field mapping definition | MongoDB to xConnect Event Mappings > MongoDB Page Event to xConnect Bounce Event |
In addition to the common mappings that apply to all email events, the following event properties are also mapped:
| Value to write to event object | Property on event object |
|---|---|
BounceReason from JSON string set on Data from source object | BounceReason |
BounceType from JSON string set on Data from source object | BounceType |
Dispatch failed events
This section describes how dispatch failed events are mapped from Sitecore 8.x to 9.
| Source object | Member of the array located at PageEvents on the page from the interaction |
| Event mapping definition | Event Mappings for MongoDB Page Events > Dispatch Failed Event |
| Event object type | Sitecore.EmailCampaign.Model.XConnect.Events.DispatchFailedEvent |
| Conditions | PageEventDefinitionId on source object is {691A6BF0-357B-426F-BF2E-C198A048E4ED} |
| Field mapping definition | MongoDB to xConnect Event Mappings > MongoDB Page Event to xConnect Dispatch Failed Event |
In addition to the common mappings that apply to all email events, the following event properties are also mapped:
| Value to write to event object | Property on event object |
|---|---|
FailureReason from JSON string set on Data from source object | FailureReason |
Email clicked events
This section describes how email clicked events are mapped from Sitecore 8.x to 9.
| Source object | Member of the array located at PageEvents on the page from the interaction |
| Event mapping definition | Event Mappings for MongoDB Page Events > Email Clicked Event |
| Event object type | Sitecore.EmailCampaign.Model.XConnect.Events.EmailClickedEvent |
| Conditions | PageEventDefinitionId on source object is {87431B9B-FA39-4780-BEB3-1047B9E61876} |
| Field mapping definition | MongoDB to xConnect Event Mappings > MongoDB Page Event to xConnect Email Clicked Event |
In addition to the common mappings that apply to all email events, the following event properties are also mapped:
| Value to write to event object | Property on event object |
|---|---|
Url.Path from source object | Url |
Email opened events
This section describes how email opened events are mapped from Sitecore 8.x to 9.
| Source object | Member of the array located at PageEvents on the page from the interaction |
| Event mapping definition | Event Mappings for MongoDB Page Events > Email Opened Event |
| Event object type | Sitecore.EmailCampaign.Model.XConnect.Events.EmailOpenedEvent |
| Conditions | PageEventDefinitionId on source object is {1AD8EBEB-24E3-46F1-9EDD-2295C5219C5E} |
| Field mapping definition | MongoDB to xConnect Event Mappings > MongoDB Page Event to xConnect Email Event |
Spam complaint events
This section describes how spam complaint events are mapped from Sitecore 8.x to 9.
| Source object | Member of the array located at PageEvents on the page from the interaction |
| Event mapping definition | Event Mappings for MongoDB Page Events > Spam Complaint Event |
| Event object type | Sitecore.EmailCampaign.Model.XConnect.Events.SpamComplaintEvent |
| Conditions | PageEventDefinitionId on source object is {D5AB8D8D-EFC1-4EEC-B7F1-80CDD05FEBD3} |
| Field mapping definition | MongoDB to xConnect Event Mappings > MongoDB Page Event to xConnect Email Event |
Unsubscribed from email events
This section describes how unsubscribed from email events are mapped from Sitecore 8.x to 9.
| Source object | Member of the array located at PageEvents on the page from the interaction |
| Event mapping definition | Event Mappings for MongoDB Page Events > Unsubscribed From Email Event |
| Event object type | Sitecore.EmailCampaign.Model.XConnect.Events.UnsubscribedFromEmailEvent |
| Conditions | PageEventDefinitionId on source object is {450ADCBF-9429-48D1-B87F-B45691833D1F} |
| Field mapping definition | MongoDB to xConnect Event Mappings > MongoDB Page Event to xConnect Email Event |