MobilePush Events

Event Notification Service (ENS) supports these event notification types and their corresponding payloads.

Notification Event Category	Notification Event Type	Description
`SendEvents`	`PushSent`	Emitted when a push notification is sent.
`SendEvents`	`PushNotSent`	Emitted when a push notification send fails to fully execute.
`SendEvents`	`PushBounced`	Emitted when a push notification is bounced back by the Push Notification Service (PNS).
`EngagementEvents`	`PushOpen`	Emitted when a user opens a push notification on their mobile device.
`EngagementEvents`	`InAppDisplay`	Emitted when an in-app message is displayed in-session due to a user taking a high-value, tracked action with their mobile app.
`EngagementEvents`	`InAppDismiss`	Emitted when a user dismisses an in-app message.
`EngagementEvents`	`InAppClick`	Emitted when a user interacts with an in-app message using the message’s Call-to-Action (CTA) button.
`EngagementEvents`	`InboxOpen`	Emitted when a user opens an inbox message.
`EngagementEvents`	`PushDeliveryReceipt`	Emitted when a push notification or inbox message is successfully delivered to users’ devices.
`EngagementEvents`	`PushInstall`	Emitted when a user installs and opens your app for the first time.
`EngagementEvents`	`PushInactive`	Emitted when a user stops using your app.
`EngagementEvents`	`PushImageClick`	Emitted when a user clicks on an image within a push notification.
`EngagementEvents`	`PushButtonClick`	Emitted when a user clicks on a button within a push notification.

PushSent, PushNotSent, PushBounced, and PushOpen events are inclusive of all send methods, such as Mobile Studio batch, Journey Builder, Transactional API, and REST API-triggered sends. To filter events by a particular send type, set up a subscription filter.

Note

Common Event Attributes

All or some of these attributes are shared for all event data payloads.

Attribute	Type	Description	Applicable to Events
`eventCategoryType`	String	The taxonomy of the event.	All events
`compositeId`	String	Event ID.	All events
`timestampUTC`	Number	UTC Epoch time.	All events
`definitionKey`	String	Name of the send definition.	Not applicable to `PushDeliveryReceipt`, `PushInactive`, and `PushInstall` events
`definitionId`	String	A unique message ID. Only present if the send method used is Transactional API.	Not applicable to `PushDeliveryReceipt`, `PushInactive`, and `PushInstall` events
`composite`	Object	Object containing composite identifiers related to the event.	All events
`composite.jobId`	String	Marketing Cloud Engagement Job ID (nullable for `EngagementEvents.PushOpen` events).	Not applicable to `PushDeliveryReceipt`, `PushInactive`, `PushInstall`, `PushImageClick`, and `PushButtonClick` events
`composite.subscriberId`	String	Internal ID of the user the message was sent to.	Not applicable to `PushDeliveryReceipt`, `PushInactive`, `PushInstall`, `PushImageClick`, and `PushButtonClick` events
`composite.deviceId`	String	Instance of the app installation on the user’s device.	All events
`mid`	Number	Member identifier of the Engagement business unit that produced the event.	All events
`eid`	Number	Enterprise identifier of the Engagement parent business unit that produced the event.	All events
`info`	Object	Object containing detailed information about the event.	All events
`info.journeyActivityName`	Object	The name of the Journey Builder activity that sent the message. Available only for events generated in Journey Builder.
`info.journeyId`	Object	The unique identifier of the associated Journey Builder journey. Returns null if unrelated to a journey.
`info.journeyName`	Object	The name of the associated Journey Builder journey. Returns null if unrelated to a journey.
`info.journeyVersion`	Object	The version number of the associated Journey Builder journey. Returns null if unrelated to a journey.
`info.campaignIds`	Object	A list of campaign IDs associated with the event.

1|

SendEvents.PushSent

ENS triggers the SendEvents.PushSent event when a push notification is successfully sent to a user’s device using the Engagement platform.

This event applies to all send methods, such as Mobile Studio batch, Journey Builder, Transactional API, and REST API-triggered sends.

1[
2  {
3    "eventCategoryType": "string",
4    "compositeId": "string",
5    "timestampUTC": "number",
6    "definitionKey": "string",
7    "definitionId": "string", // Transactional API only
8    "composite": {
9      "jobId": "string",
10      "subscriberId": "string",
11      "deviceId": "string"
12    },
13    "eid": "number",
14    "mid": "number"
15    "info": {
16      "to": "string",
17      "contactKey": "string",
18      "requestId": "string",
19      "messageKey": "string", // Transactional API only
20      "appId": "string",
21      "sendMethod": "string",
22      "device": {
23        "platform": "string"
24      },
25    },
26  }
27]

SendEvents.PushSent Info Attributes

Attribute	Type	Description
`to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`contactKey`	String	A unique ID for the contact.
`requestId`	String	A unique ID for the request. Used to track message status.
`sendMethod`	String	The method used to send the push notification. Potential values include `MobileStudio`, `JourneyBuilder`, `TriggeredSend`, and `LLTS` (Transactional API).
`messageKey`	String	A unique ID for the message. Only available if `sendMethod` is `LLTS`.
`appId`	String	The MobilePush app ID.
`device`	Object	An object containing device information.
`device.platform`	String	The platform of the receiver’s device. For example, `iOS`.

SendEvents.PushSent Payload Example

This event notification payload is an example of what your callback receives for a SendEvents.PushSent event.

1[
2  {
3    "eventCategoryType": "SendEvents.PushSent",
4    "compositeId": "48caf8f7-13ae-422f-8d3a-0399179993f2",
5    "timestampUTC": 1719406100000,
6    "definitionKey": "Journey Builder Push Send",
7    "composite": {
8      "jobId": "a727294f-d556-4a62-b8bb-83c27e2c56b2",
9      "subscriberId": "543990938",
10      "deviceId": "33FFFADB-6DD0-4B7B-8494-06BB9FB3BE3C"
11    },
12    "eid": 523014241,
13    "mid": 523014241,
14    "info": {
15      "to": "user@example.com",
16      "contactKey": "user@example.com",
17      "requestId": "de6acf5d-6874-4f55-bf43-6a6f078a9489",
18      "appId": "6039399b-faba-46b6-afae-1d56aa6033e4",
19      "sendMethod": "JourneyBuilder",
20      "device": {
21        "platform": "iOS"
22      }
23    }
24  }
25]

SendEvents.PushNotSent

ENS triggers the SendEvents.PushNotSent event when a push notification send fails. Send failures can occur due to various reasons, including network or service errors, Object Message Mapping (OMM) errors, or AMPscript errors.

This event applies to all send methods, such as Mobile Studio batch, Journey Builder, Transactional API, and REST API-triggered sends.

1[
2  {
3    "eventCategoryType": "string",
4    "compositeId": "string",
5    "timestampUTC": "number",
6    "definitionKey": "string",
7    "definitionId": "string", // Transactional API only
8    "composite": {
9      "jobId": "string",
10      "subscriberId": "string",
11      "deviceId": "string",
12    },
13    "mid": "string",
14    "eid": "string",
15    "info": {
16      "to": "string",
17      "contactKey": "string",
18      "requestId": "string",
19      "messageKey": "string", // Transactional API only
20      "appId": "string",
21      "sendMethod": "string",
22      "device": {
23        "platform": "string",
24      },
25      "statusCode": "string",
26      "statusMessage": "string",
27      "journeyActivityId": "7ae1b270-93de-4b87-a447-c6947f3ba55e",
28      "journeyActivityName": "Mobile_Onboarding_Automation_Push",
29      "journeyId": "f0ac17b2-a096-4229-a3af-af3de19ccb41",
30      "journeyName": "Onboarding_All_New_Push_iPhone_and_Android",
31      "journeyVersion": 2,
32      "campaignIds": []
33    }
34  }
35]

SendEvents.PushNotSent Info Attributes

Attribute	Type	Description
`to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`contactKey`	String	A unique ID for the contact.
`requestId`	String	A unique ID for the request. Used to track message status.
`sendMethod`	String	The method used to send the push notification. Potential values include `MobileStudio`, `JourneyBuilder`, `TriggeredSend`, and `LLTS` (Transactional API).
`messageKey`	String	A unique ID for the message. Only available if `sendMethod` is `LLTS`.
`appId`	String	The MobilePush app ID.
`statusCode`	String	The message send status code or enum.
`statusMessage`	String	Brief error message.
`device`	Object	An object containing device information.
`device.platform`	String	The platform of the receiver’s device. For example, `iOS`.

SendEvents.PushNotSent Payload Example

This event notification payload is an example of what your callback receives for a SendEvents.PushNotSent event.

1[
2  {
3    "definitionId": "9e085a02-e228-ef11-a5b4-5cba2c7bb618",
4    "definitionKey": "testDefinitionKey",
5    "info": {
6      "to": "user@example.com",
7      "contactKey": "user@example.com",
8      "requestId": "fabb2521-f3d3-41b0-9e2b-6f1c351048a2",
9      "messageKey": "tjamRCAhPUWAiFbxU0hdDQ",
10      "statusCode": "14",
11      "statusMessage": "error message",
12      "sendMethod": "LLTS",
13      "appId": "6039399b-faba-46b6-afae-1d56aa6033e4",
14      "device": {
15        "platform": "iOS"
16      }
17    },
18    "composite": {
19      "jobId": "106a324d-54c0-4f20-b643-bdac687a1f24",
20      "subscriberId": "543990938",
21      "deviceId": "33FFFADB-6DD0-4B7B-8494-06BB9FB3BE3C"
22    },
23    "eventCategoryType": "SendEvents.PushNotSent",
24    "compositeId": "415fbbff-be62-49bb-b290-057fe76a4067",
25    "timestampUTC": 1719342157000,
26    "eid": 523014241,
27    "mid": 523014241
28  }
29]

SendEvents.PushBounced

ENS triggers the SendEvents.PushBounced event when a push notification is sent by the Engagement servers but is bounced back by the PNS, such as Apple Push Notification Service (APNS) or Firebase Cloud Messaging (FCM). Push notifications can bounce due to various reasons, such as the recipient uninstalling the app from their device or a mismatch between the ServerKey and SenderID.

This event applies to all send methods, such as Mobile Studio batch, Journey Builder, Transactional API, and REST API-triggered sends.

1[
2  {
3    "eventCategoryType": "string",
4    "compositeId": "string",
5    "timestampUTC": "number",
6    "definitionKey": "string",
7    "definitionId": "string", // Transactional API only
8    "composite": {
9      "jobId": "string",
10      "subscriberId": "string",
11      "deviceId": "string",
12    },
13    "mid": "string",
14    "eid": "string",
15    "info": {
16      "to": "string",
17      "contactKey": "string",
18      "requestId": "string",
19      "messageKey": "string", // Transactional API only
20      "appId": "string",
21      "sendMethod": "string",
22      "device": {
23        "platform": "string",
24      },
25      "bounceCode": "string",
26      "bounceMessage": "string",
27    }
28  }
29]

SendEvents.PushBounced Info Attributes

Attribute	Type	Description
`to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`contactKey`	String	A unique ID for the contact.
`requestId`	String	A unique ID for the request. Used to track message status.
`sendMethod`	String	The method used to send the push notification. Potential values include `MobileStudio`, `JourneyBuilder`, `TriggeredSend`, and `LLTS` (Transactional API).
`messageKey`	String	A unique ID for the message. Only available if `sendMethod` is `LLTS`.
`appId`	String	The MobilePush app ID.
`bounceCode`	String	One word feedback from APNS or FCM.
`bounceMessage`	String	Bounce reason.
`device`	Object	An object containing device information.
`device.platform`	String	The platform of the receiver’s device. For example, `iOS`.

SendEvents.PushBounced Payload Example

This event notification payload is an example of what your callback receives for a SendEvents.PushBounced event.

1[
2  {
3    "definitionKey": "SDKX - API Triggered Push",
4    "info": {
5      "to": "user@example.com",
6      "contactKey": "user@example.com",
7      "requestId": "ebbf6e00-062a-4e36-91d8-662961c852e7",
8      "bounceCode": "BadRequest",
9      "bounceMessage": "BadDeviceToken",
10      "sendMethod": "TriggeredSend",
11      "appId": "6039399b-faba-46b6-afae-1d56aa6033e4",
12      "device": {
13        "platform": "iOS"
14      }
15    },
16    "composite": {
17      "jobId": "f6db0df8-8b66-4aaa-9c08-39b82f211f53",
18      "subscriberId": "543990938",
19      "deviceId": "33FFFADB-6DD0-4B7B-8494-06BB9FB3BE3C"
20    },
21    "eventCategoryType": "SendEvents.PushBounced",
22    "compositeId": "cd3633ca-3968-447f-8310-dfaefdddc5ec",
23    "timestampUTC": 1719341784000,
24    "eid": 523014241,
25    "mid": 523014241,
26    "journeyActivityId": "7ae1b270-93de-4b87-a447-c6947f3ba55e",
27    "journeyActivityName": "Mobile_Onboarding_Automation_Push",
28    "journeyId": "37a937bc-88b0-448a-bbd4-7f6427608862",
29    "journeyName": "Onboarding_All_New_Push_iPhone_and_Android",
30    "journeyVersion": 2,
31    "campaignIds": [123, 456]
32  }
33]

EngagementEvents.PushOpen

ENS triggers the EngagementEvents.PushOpen event when a user opens a push notification on their mobile device.

This event must originate from the MobilePush SDK.

1[
2  {
3    "eventCategoryType": "string",
4    "compositeId": "string",
5    "timestampUTC": "number",
6    "definitionKey": "string",
7    "definitionId": "string", // Transactional API only
8    "composite": {
9      "jobId": "string",
10      "subscriberId": "string",
11      "deviceId": "string",
12    },
13    "mid": "string",
14    "eid": "string",
15    "info": {
16      "to": "string",
17      "contactKey": "string",
18      "requestId": "string",
19      "messageKey": "string", // Transactional API only
20      "appId": "string",
21      "sendMethod": "string",
22      "device": {
23        "platform": "string",
24      },
25      "journeyActivityId": "7ae1b270-93de-4b87-a447-c6947f3ba55e",
26      "journeyActivityName": "Push Send Activity",
27      "journeyId": "f0ac17b2-a096-4229-a3af-af3de19ccb41",
28      "journeyName": "New Journey - June 26 2024 ",
29      "journeyVersion": 2,
30      "campaignIds": [123]
31    }
32  }
33]

EngagementEvents.PushOpen Info Attributes

Attribute	Type	Description
`to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`contactKey`	String	A unique ID for the contact.
`requestId`	String	A unique ID for the request. Used to track message status.
`sendMethod`	String	The method used to send the push notification. Potential values include `MobileStudio`, `JourneyBuilder`, `TriggeredSend`, and `LLTS` (Transactional API).
`messageKey`	String	A unique ID for the message. Only available if `sendMethod` is `LLTS`.
`appId`	String	The MobilePush app ID.
`device`	Object	An object containing device information.
`device.platform`	String	The platform of the receiver’s device. For example, `iOS`.

EngagementEvents.PushOpen Payload Example

This event notification payload is an example of what your callback receives for a EngagementEvents.PushOpen event.

1[
2  {
3    "definitionKey": "SDKX - API Triggered Push",
4    "info": {
5      "to": "user@example.com",
6      "contactKey": "user@example.com",
7      "requestId": "0cdbc544-72fd-4a24-a876-219e79b18e98",
8      "sendMethod": "TriggeredSend",
9      "appId": "6039399b-faba-46b6-afae-1d56aa6033e4",
10      "device": {
11        "platform": "iOS"
12      }
13    },
14    "composite": {
15      "jobId": "106a324d-54c0-4f20-b643-bdac687a1f24",
16      "subscriberId": "123456789",
17      "deviceId": "4618D83C-F3C2-4C95-AC13-EB3B26C23F84"
18    },
19    "eventCategoryType": "EngagementEvents.PushOpen",
20    "compositeId": "b8ad36da-1119-4e68-977d-539cf89b77d1",
21    "timestampUTC": 1719341626000,
22    "eid": 523014241,
23    "mid": 523014241
24  }
25]

EngagementEvents.InAppDisplay

ENS triggers the EngagementEvents.InAppDisplay event when an in-app message is displayed in-session due to the user peforming a high-value, tracked action within their mobile app.

This event must originate from the MobilePush SDK.

1[
2  {
3    "eventCategoryType": "string",
4    "timestampUTC": "number",
5    "journeyName": "string",
6    "journeyId": "string",
7    "journeyVersion": "string",
8    "journeyActivityName": "string",
9    "journeyActivityId": "string",
10    "composite": {
11      "subscriberId": "string",
12      "deviceId": "string",
13    },
14    "messageName": "string",
15    "messageId": "integer",
16    "mid": "string",
17    "eid": "string",
18    "info": {
19      "to": "string",
20      "contactKey": "string",
21      "appId": "string",
22      "messageTrigger": "string",
23      "device": {
24        "platform": "string",
25      },
26    }
27  }
28]

EngagementEvents.InAppDisplay Info Attributes

Attribute	Type	Description
`to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`contactKey`	String	A unique ID for the contact.
`appId`	String	The MobilePush app ID.
`messageTrigger`	String	The event that triggered the in-app message display.
`device`	Object	An object containing device information.
`device.platform`	String	The platform of the receiver’s device. Potential values include `iOS` and `Android`.

EngagementEvents.InAppDisplay Payload Example

This event notification payload is an example of what your callback receives for a EngagementEvents.InAppDisplay event.

1[
2  {
3    "eventCategoryType": "EngagementEvents.PushOpen",
4    "timestampUTC": 1719406100000,
5    "journeyName": "Welcome",
6    "journeyId": "a6b5c4d3e2f1",
7    "journeyVersion": "1.0",
8    "journeyActivityName": "Push Notification Activity",
9    "journeyActivityId": "activity123",
10    "composite": {
11      "subscriberId": "subscriberIdString",
12      "deviceId": "device101112"
13    },
14    "messageName": "Welcome Message",
15    "messageId": 12345,
16    "mid": "mid6789",
17    "eid": "eid2345",
18    "info": {
19      "to": "user@example.com",
20      "contactKey": "user@example.com",
21      "appId": "app09876",
22      "messageTrigger": "User Action",
23      "device": {
24        "platform": "iOS"
25      }
26    }
27  }
28]

EngagementEvents.InAppDismiss

ENS triggers the EngagementEvents.InAppDismiss event when an in-app message is dismissed in-session, either by the user hitting the X button or by timing out.

This event must originate from the MobilePush SDK.

1[
2  {
3    "eventCategoryType": "string",
4    "timestampUTC": "number",
5    "journeyName": "string",
6    "journeyId": "string",
7    "journeyVersion": "string",
8    "journeyActivityName": "string",
9    "journeyActivityId": "string",
10    "composite": {
11      "subscriberId": "string",
12      "deviceId": "string",
13    },
14    "messageName": "string",
15    "messageId": "integer",
16    "mid": "string",
17    "eid": "string",
18    "info": {
19      "to": "string",
20      "contactKey": "string",
21      "appId": "string",
22      "displayDuration": "integer",
23      "messageTrigger": "string",
24      "dismissType": "integer",
25      "device": {
26        "platform": "string",
27      },
28    }
29  }
30]

EngagementEvents.InAppDismiss Info Attributes

Attribute	Type	Description
`to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`contactKey`	String	A unique ID for the contact.
`appId`	String	The MobilePush app ID.
`displayDuration`	Integer	In-app message display duration.
`messageTrigger`	String	The event that triggered the in-app message display.
`dismissType`	Integer	Denotes whether the in-app message was user-dismissed or time-dismissed.
`device`	Object	An object containing device information.
`device.platform`	String	The platform of the receiver’s device. Potential values include `iOS` and `Android`.

EngagementEvents.InAppDismiss Payload Example

This event notification payload is an example of what your callback receives for a EngagementEvents.InAppDismiss event.

1[
2  {
3    "eventCategoryType": "EngagementEvents.InAppDismiss",
4    "timestampUTC": 1719406100000,
5    "journeyName": "Welcome",
6    "journeyId": "a6b5c4d3e2f1",
7    "journeyVersion": "1.0",
8    "journeyActivityName": "Push Notification Activity",
9    "journeyActivityId": "activity123",
10    "composite": {
11      "subscriberId": "subscriberIdString",
12      "deviceId": "device101112"
13    },
14    "messageName": "Welcome Message",
15    "messageId": 12345,
16    "mid": "mid6789",
17    "eid": "eid2345",
18    "info": {
19      "to": "user@example.com",
20      "contactKey": "user@example.com",
21      "appId": "app09876",
22      "displayDuration": 5,
23      "messageTrigger": "User Action",
24      "dismissType": 1,
25      "device": {
26        "platform": "iOS"
27      }
28    }
29  }
30]

EngagementEvents.InAppClick

ENS triggers the EngagementEvents.InAppClick event when a user interacts with an in-app message using the message’s CTA button during an app session.

This event must originate from the MobilePush SDK.

1[
2  {
3    "eventCategoryType": "string",
4    "timestampUTC": "number",
5    "journeyName": "string",
6    "journeyId": "string",
7    "journeyVersion": "string",
8    "journeyActivityName": "string",
9    "journeyActivityId": "string",
10    "composite": {
11      "subscriberId": "string",
12      "deviceId": "string",
13    },
14    "messageName": "string",
15    "messageId": "integer",
16    "mid": "string",
17    "eid": "string",
18    "info": {
19      "to": "string",
20      "contactKey": "string",
21      "appId": "string",
22      "buttonClicked": "string",
23      "displayDuration": "integer",
24      "messageTrigger": "string",
25      "device": {
26        "platform": "string",
27      },
28    }
29  }
30]

EngagementEvents.InAppClick Info Attributes

Attribute	Type	Description
`to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`contactKey`	String	A unique ID for the contact.
`appId`	String	The MobilePush app ID.
`buttonClicked`	String	The name, CTA, or title of the button the user clicked.
`displayDuration`	Integer	In-app message display duration.
`messageTrigger`	String	The event that triggered the in-app message display.
`dismissType`	Integer	Denotes whether the in-app message was user-dismissed or time-dismissed.
`device`	Object	An object containing device information.
`device.platform`	String	The platform of the receiver’s device. Potential values include `iOS` and `Android`.

EngagementEvents.InAppClick Payload Example

This event notification payload is an example of what your callback receives for a EngagementEvents.InAppClick event.

1[
2  {
3    "eventCategoryType": "EngagementEvents.InAppClick",
4    "timestampUTC": 1719406100000,
5    "journeyName": "Welcome Journey",
6    "journeyId": "a1b2c3d4e5f6",
7    "journeyVersion": "1.0",
8    "journeyActivityName": "InApp Message Activity",
9    "journeyActivityId": "activity123",
10    "composite": {
11      "subscriberId": "subscriber456",
12      "deviceId": "device101112"
13    },
14    "messageName": "Welcome Message",
15    "messageId": 12345,
16    "mid": "mid6789",
17    "eid": "eid2345",
18    "info": {
19      "to": "user@example.com",
20      "contactKey": "contact7890",
21      "appId": "app09876",
22      "buttonClicked": "Accept",
23      "displayDuration": 5,
24      "messageTrigger": "User Action",
25      "device": {
26        "platform": "iOS"
27      }
28    }
29  }
30]

EngagementEvents.InboxOpen

ENS triggers the EngagementEvents.InboxOpen event when a user opens an inbox message that’s been downloaded to the mobile app’s inbox.

This event must originate from the MobilePush SDK.

1[
2  {
3    "eventCategoryType": "string",
4    "timestampUTC": "number",
5    "composite": {
6      "subscriberId": "string",
7      "deviceId": "string",
8    },
9    "messageName": "string",
10    "messageId": "integer",
11    "mid": "string",
12    "eid": "string",
13    "info": {
14      "to": "string",
15      "contactKey": "string",
16      "requestId": "string",
17      "appId": "string",
18      "device": {
19        "platform": "string",
20      },
21    },
22  }
23]

EngagementEvents.InboxOpen Info Attributes

Attribute	Type	Description
`to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`contactKey`	String	A unique ID for the contact.
`appId`	String	The MobilePush app ID.
`requestId`	String	A unique ID used to track message status.
`device`	Object	An object containing device information.
`device.platform`	String	The platform of the receiver’s device. Potential values include `iOS` and `Android`.

EngagementEvents.InboxOpen Payload Example

This event notification payload is an example of what your callback receives for a EngagementEvents.InboxOpen event.

1[
2  {
3    "eventCategoryType": "EngagementEvents.InboxOpen",
4    "timestampUTC": 1719406100000,
5    "composite": {
6      "subscriberId": "subscriber123",
7      "deviceId": "device101112"
8    },
9    "messageName": "Welcome Message",
10    "messageId": 12345,
11    "mid": "mid6789",
12    "eid": "eid2345",
13    "info": {
14      "to": "user@example.com",
15      "contactKey": "contact7890",
16      "requestId": "req3456",
17      "appId": "app09876",
18      "device": {
19        "platform": "iOS"
20      }
21    }
22  }
23]

EngagementEvents.PushDeliveryReceipt

ENS triggers the EngagementEvents.PushDeliveryReceipt event when a push notification or inbox message is successfully delivered to users’ devices.

This event must originate from the MobilePush SDK.

EngagementEvents.PushDeliveryReceipt Unique Attributes

Attribute	Type	Description
`composite.deviceId`	String	Instance of the app installation on the user’s device.
`composite.contactKey`	String	An unique ID for the subscriber/contact.
`composite.appId`	String	The MobilePush app ID.
`composite.messageId`	Number	A unique ID for the message.
`info.device`	Object	An object containing device information.
`info.messageDateUTC`	String	UTC epoch time of the message send date.
`info.messageType`	Number	An integer representing the message type. A value of 1 indicates Push Notification, and a value of 8 indicates Alert + Inbox.
`info.recieptDateUTC`	String	UTC epoch time of message receipt date
`info.sendMethod`	String	The method used to send the push notification. Potential values include `MobileStudio`, `JourneyBuilder`, `TriggeredSend`, and `LLTS` (Transactional API).
`info.journeyActivityId`	String	Unique ID for the Journey Builder activity that sent this message. (Only available for events generated in Journey Builder).
`info.journeyActivityName`	String	Name of the Journey Builder activity that sent the message. (Only available for events generated in Journey Builder).
`info.journeyId`	String	Unique ID of the Journey Builder journey. (Empty if not related to a Journey Builder journey).
`info.journeyName`	String	Name of the Journey Builder journey. (Empty if not related to a Journey Builder journey).
`info.journeyVersion`	String	Version of the Journey Builder journey. (Empty if not from a Journey Builder journey).
`info.requestId`	String	Unique ID for the request generated by the inbound service. Used to track message status.
`info.messageKey`	String	Unique ID for the message. Only available if `sendMethod` is `LLTS`.
`info.device.platform`	String	Mobile device platform. (Android or iOS).

EngagementEvents.PushDeliveryReceipt Payload Example

1[
2  {
3    "composite": {
4      "appId": "15404780-2c03-4971-ba8c-a8ac60c780d0",
5      "contactKey": "testparty",
6      "deviceId": "6e69d150-7416-44dd-8550-1b2dcaf9f0a1",
7      "messageId": 4672
8    },
9    "compositeId": "6550dc12-0b49-4445-8407-b3a9afe95712",
10    "eid": 519000232,
11    "eventCategoryType": "EngagementEvents.PushDeliveryReceipt",
12    "info": {
13      "device": {
14        "platform": "Android"
15      },
16      "messageDateUTC": 1739485300000,
17      "messageType": 1,
18      "receiptDateUTC": 1739485378000,
19      "sendMethod": "MobileStudio"
20    },
21    "mid": 519000232,
22    "timestampUTC": 1739485371000
23  },
24  {
25    "composite": {
26      "appId": "15404780-2c03-4971-ba8c-a8ac60c780d0",
27      "contactKey": "testparty",
28      "deviceId": "07636fc4-cc16-42e0-b1d0-883d5c687c77",
29      "messageId": 4675
30    },
31    "compositeId": "33a5bd82-0207-4f66-9536-629ff28e21c2",
32    "eid": 519000232,
33    "eventCategoryType": "EngagementEvents.PushDeliveryReceipt",
34    "info": {
35      "device": {
36        "platform": "Android"
37      },
38      "journeyActivityId": "7a03f41d-e4b4-4c97-9134-f1b50720e19a",
39      "journeyActivityName": "Mobile Message February 13, 2025(11:16:27 AM)",
40      "journeyId": "e16bfaef-3b8f-4f81-aae2-c8ab8d27dab2",
41      "journeyName": "New Journey - February 13 2025 at 11.25 AM",
42      "journeyVersion": 1,
43      "messageDateUTC": 1739496623000,
44      "messageType": 1,
45      "receiptDateUTC": 1739496626000,
46      "sendMethod": "JourneyBuilder"
47    },
48    "mid": 519000232,
49    "timestampUTC": 1739496621000
50  }
51]

EngagementEvents.PushInstall

ENS triggers the EngagementEvents.PushInstall event when a user installs and opens your app for the first time.

This event must originate from the MobilePush SDK.

EngagementEvents.PushInstall Unique Attributes

Attribute	Type	Description
`composite.deviceId`	String	Instance of the app installation on the user’s device.
`composite.contactKey`	String	A unique ID for the subscriber/contact.
`composite.appId`	String	The MobilePush app ID.
`sdkVersion`	String	Version of the SDK.
`info.device`	Object	An object containing device information.
`info.device.platformVersion`	String	Version of the platform
`info.device.hwid`	String	Details of the hardware of the mobile.
`info.installDateUTC`	Number	UTC epoch time for the time when the device installation happened.
`info.device.sdkVersion`	String	Version of the SDK.
`info.device.platform`	String	Type of the platform in the mobile device (Android/iOS).

EngagementEvents.PushInstall Payload Example

1[
2  {
3    "compositeId": "42a26260-6af6-49ed-bf88-ba95fe66d276",
4    "timestampUTC": 1739500855630,
5    "composite": {
6      "deviceId": "qcQFp_kmijdwTp1mpQvASfaiyCjjZF",
7      "contactKey": "phvhmzshjwygprfazxs4wrbi_jbghy",
8      "appId": "2d4f31ef-32db-44c8-b8c7-2d34d9e90837"
9    },
10    "info": {
11      "device": {
12        "sdkVersion": "6.1.0",
13        "platformVersion": "6.0",
14        "hwid": "Android Jellybone",
15        "platform": "Android"
16      }
17    },
18    "installDateUTC": 1739456865417,
19    "eventCategoryType": "EngagementEvents.PushInstall",
20    "eid": 519000232,
21    "mid": 519000232
22  }
23]

1[
2  {
3    "compositeId": "715b36d1-41a4-4534-b00f-2ea85aadc5d5",
4    "timestampUTC": 1739546344669,
5    "composite": {
6      "deviceId": "07636fc4-cc16-42e0-b1d0-883d5c687c77",
7      "contactKey": "985a5d64-b87f-41c0-9c28-cd7e65d6fd22",
8      "appId": "64c1bd92-4164-4313-9022-835ffde32e4f"
9    },
10    "info": {
11      "device": {
12        "sdkVersion": "9.0.0",
13        "platformVersion": "13",
14        "hwid": "Google Pixel 4",
15        "platform": "Android"
16      }
17    },
18    "installDateUTC": 1739546250450,
19    "eventCategoryType": "EngagementEvents.PushInstall",
20    "eid": 519000232,
21    "mid": 519000232
22  }
23]

EngagementEvents.PushInactive

ENS triggers the EngagementEvents.PushInactive event when a user stops using your app.

This event must originate from the MobilePush SDK.

EngagementEvents.PushInactive Unique Attributes

Attribute	Type	Description
`composite.deviceId`	String	Unique ID of the app installation on the user’s device.
`composite.contactKey`	String	Unique ID for the contact.
`composite.appId`	String	The MobilePush app ID.
`info.daysInactive`	Number	Number of days the device was inactive, if `info.reason` is `Inactivity`.
`info.device`	Object	An object containing device information.
`info.device.platformVersion`	String	Operating system version of the mobile device.
`info.device.hwid`	String	Hardware identifier of the mobile device.
`info.reason`	String	Reason for inactivity.
`info.device.platform`	String	Type of the platform in the mobile device (`Android`/`iOS`).

EngagementEvents.PushInactive Payload Example

1[
2  {
3    "composite": {
4      "appId": "c04de7cc-9547-46a9-869d-070eb7eb6e9a",
5      "contactKey": "zehner-test-1234",
6      "deviceId": "27941cb9-4b4d-4433-a95d-bb6890419fd3"
7    },
8    "compositeId": "d57f171a-bb11-44d2-81ee-6b92e3ad9e92",
9    "eid": 519000232,
10    "eventCategoryType": "EngagementEvents.PushInactive",
11    "info": {
12      "daysInactive": 0,
13      "device": {
14        "hwid": "Postman Device",
15        "platform": "iPhone OS",
16        "platformVersion": "18"
17      },
18      "reason": "Inactivity"
19    },
20    "mid": 519000232,
21    "timestampUTC": 1738942380000
22  }
23]

EngagementEvents.PushImageClick

ENS triggers the EngagementEvents.PushImageClick event when a user clicks on an image within a push notification sent via Journey Builder.

This event must originate from the MobilePush SDK.

EngagementEvents.PushImageClick Unique Attributes

Attribute	Type	Description
`composite.contactKey`	String	Unique ID for the contact.
`composite.deviceId`	String	Unique ID of the app installation on the user’s device.
`composite.messageId`	String	Unique ID for the message.
`composite.appId`	String	The MobilePush app ID.
`info.imageId`	String	Unique ID of the image that the user clicked.
`info.journeyActivityId`	String	Unique ID for the Journey Builder activity that sent this message. (Only available for events generated in Journey Builder).
`info.journeyActivityName`	String	Name of the Journey Builder activity that sent the message. (Only available for events generated in Journey Builder).
`info.journeyId`	String	Unique ID of the Journey Builder journey. (Empty if not related to a Journey Builder journey).
`info.journeyName`	String	Name of the Journey Builder journey. (Empty if not related to a Journey Builder journey).
`info.journeyVersion`	String	Version of the Journey Builder journey. (Empty if not from a Journey Builder journey).
`info.sendMethod`	String	The method used to send the push notification. Potential values include `MobileStudio`, `JourneyBuilder`, `TriggeredSend`, and `LLTS` (Transactional API).
`info.to`	String	The unique address the message was sent to. In this case, the end user’s device ID.
`composite.requestId`	String	Unique ID for the request generated by the inbound service. Used to track message status.
`info.messageKey`	String	Unique ID for the message. Only available if `sendMethod` is `LLTS`.

EngagementEvents.PushImageClick Payload Examples

1[
2  {
3    "composite": {
4      "contactKey": "nama@sfdc2.com",
5      "deviceId": "bb22a240-defb-4819-95ac-6482999b6844",
6      "messageId": 1619
7    },
8    "compositeId": "8a8358be-96e4-4cdf-a6e6-6850bbc8be5c",
9    "eid": 519000232,
10    "eventCategoryType": "EngagementEvents.PushImageClick",
11    "info": {
12      "appId": "15404780-2c03-4971-ba8c-a8ac60c780d0",
13      "imageId": "Title2",
14      "journeyActivityId": "62440865-42f0-4f0f-9d17-a00a13ee6909",
15      "journeyActivityName": "Carousel_9.0.0",
16      "journeyId": "69b63f03-f4ce-4891-b9fb-d9c2d9092687",
17      "journeyName": "Carousel_9.0.0",
18      "journeyVersion": 1,
19      "sendMethod": "Journey Builder"
20    },
21    "mid": 519000232,
22    "timestampUTC": 1739394844000
23  }
24]

1[
2  {
3    "info": {
4      "imageId": "img-1",
5      "appId": "64c1bd92-4164-4313-9022-835ffde32e4f",
6      "sendMethod": "Journey Builder",
7      "journeyName": "New Journey - February 14 2025 at 10.01 AM",
8      "journeyId": "c48c936c-386a-4ae2-b333-691cba8d721a",
9      "journeyVersion": 1,
10      "journeyActivityName": "CarouselMessage_02_12_Demo",
11      "journeyActivityId": "97a2527f-ae84-47a5-bb1c-c4f362b8b28d"
12    },
13    "composite": {
14      "deviceId": "C614E977-188E-43E6-B6D3-B5D1059FE725",
15      "contactKey": "nitin-ios",
16      "messageId": 4752,
17      "requestId": "087c1605-c851-4a44-9696-89c8f10dd78b"
18    },
19    "compositeId": "d9ba09d1-2ac1-4f29-8d1d-a20a0a5a2f28",
20    "timestampUTC": 1739567295000,
21    "eventCategoryType": "EngagementEvents.PushImageClick",
22    "eid": 519000232,
23    "mid": 519000232
24  }
25]

1[
2  {
3    "info": {
4      "imageId": "img-3",
5      "appId": "64c1bd92-4164-4313-9022-835ffde32e4f",
6      "sendMethod": "Journey Builder",
7      "journeyName": "New Journey - February 14 2025 at 10.01 AM",
8      "journeyId": "c48c936c-386a-4ae2-b333-691cba8d721a",
9      "journeyVersion": 1,
10      "journeyActivityName": "CarouselMessage_02_12_Demo",
11      "journeyActivityId": "97a2527f-ae84-47a5-bb1c-c4f362b8b28d"
12    },
13    "composite": {
14      "deviceId": "4F2F094D-440D-4B24-942E-3A14542AA808",
15      "contactKey": "abhinav_dr",
16      "messageId": 4752,
17      "requestId": "e8581650-1b83-465e-bd60-d95e32312a07"
18    },
19    "compositeId": "0ae63385-5264-4f2b-a4ab-6ca588d774c4",
20    "timestampUTC": 1739567854000,
21    "eventCategoryType": "EngagementEvents.PushImageClick",
22    "eid": 519000232,
23    "mid": 519000232
24  }
25]

EngagementEvents.PushButtonClick

ENS triggers the EngagementEvents.PushButtonClick event when a user clicks a button in a push notification sent via Journey Builder.

This event must originate from the MobilePush SDK.

EngagementEvents.PushButtonClick Unique Attributes

Attribute	Type	Description
`composite.contactKey`	String	Unique ID for the contact.
`composite.deviceId`	String	Unique ID of the app installation on the user’s device.
`composite.messageId`	String	Unique message ID.
`composite.requestId`	String	Unique ID for the request generated by the inbound service. Used to track message status.
`composite.appId`	String	The MobilePush app ID.
`info.buttonId`	String	Unique ID of the button that was clicked.
`info.journeyActivityId`	String	Unique ID for the Journey Builder activity that sent this message. (Only available for events generated in Journey Builder).
`info.journeyActivityName`	String	Name of the Journey Builder activity that sent the message. (Only available for events generated in Journey Builder).
`info.journeyId`	String	Unique ID of the Journey Builder journey. (Empty if not related to a Journey Builder journey).
`info.journeyName`	String	Name of the Journey Builder journey. (Empty if not related to a Journey Builder journey).
`info.journeyVersion`	String	Version of the Journey Builder journey. (Empty if not from a Journey Builder journey).
`info.sendMethod`	String	The method used to send the push notification. Potential values include `MobileStudio`, `JourneyBuilder`, `TriggeredSend`, and `LLTS` (Transactional API).
`info.to`	String	The unique address the message was sent to. In this case, the end-user’s device ID.
`info.messageKey`	String	Unique ID for the message. Only available if `sendMethod` is `LLTS`.

EngagementEvents.PushButtonClick Payload Examples

1[
2  {
3    "composite": {
4      "contactKey": "nama@sfdc2.com-qa1",
5      "deviceId": "96eba82e-7459-4482-bd18-07203a90e22c",
6      "messageId": 3818,
7      "requestId": "96d5f494-4a2a-4458-839d-b99bb6b138de"
8    },
9    "compositeId": "699ffc65-3ab0-4d0b-a086-19b1efcf8dba",
10    "eid": 519000232,
11    "eventCategoryType": "EngagementEvents.PushButtonClick",
12    "info": {
13      "appId": "64c1bd92-4164-4313-9022-835ffde32e4f",
14      "buttonId": "btn-2",
15      "journeyActivityId": "7ae1b270-93de-4b87-a447-c6947f3ba55e",
16      "journeyActivityName": "testing-session-button-2-7",
17      "journeyId": "37a937bc-88b0-448a-bbd4-7f6427608862",
18      "journeyName": "testing-session-2-7",
19      "journeyVersion": 7,
20      "sendMethod": "Journey Builder"
21    },
22    "mid": 519000232,
23    "timestampUTC": 1738932761000
24  }
25]