The engagement split activity is used to change the path for a contact based on how they did or didn't interact with an email. It allows you to define logical flows for your journey based on clicks and opens. This activity type can’t be used in a custom activity.
Helpful Hints
- This activity works only with the send email types for splitting the journey path.
- The outcome of this decision affects goal statistics.
Journey Specification Format
The activity must be formatted as specified in this sample request. This JSON object is included in the activities array of a journey, as defined in the Journey Specification.
{
"key": "ENGAGEMENTDECISION-1",
"name": "Engagement Decision",
"description": "Description for this Activity",
"type": "EngagementDecision",
"outcomes": [
{
"next": "WAIT-[#]",
"arguments": {
"when": true
}
},
{
"next": "WAIT-[#]",
"arguments": {
"when": false
}
}
],
"configurationArguments": {
"refActivityCustomerKey": "EMAIL-1",
"statsTypeId": 2, // 2 = Email opened, 3 = Email clicked, 6 = Email bounced
"statusUrlId": "0"
},
"metaData": {
"refActivityName": "<nameOfEmailForReference",
}
}
The response resembles this example.
{
"id": "<guid>",
"key": "ENGAGEMENTDECISION-1", // The UI adds an incremented number each time a new activity of this type is brought onto the stage.
"name": "Engagement Decision", // "Last Modified Today"
"description": "Description for this Activity",
"type": "EngagementDecision",
"outcomes": [
{
"key": "<guid>",
"next": "WAIT-[#]",
"arguments": {
"when": true
}
},
{
"key": "<guid>",
"next": "WAIT-[#]",
"arguments": {
"when": false
}
}
],
"configurationArguments": {
"refActivityCustomerKey": "EMAIL-1",
"statsTypeId": 2,
"statusUrlId": "0"
},
"metaData": {
"refActivityName": "<nameOfEmailForReference",
}
}