Use this page to understand the events and fields that the Engage Mobile SDK accepts for Mobile In-App campaign evaluation. The SDK provides the trigger API and campaign measurement events; the customer defines business event names and fields.
Measurement record details belong to the Developer Guide. See Mobile In-App Measurement for the measurement destination and schema.
Mobile In-App event contracts are part of the preview experience. Event names, fields, and SDK behavior may change before general availability.
The SDK supports two event categories for Mobile In-App:
| Category | Events | Owner |
|---|---|---|
| Trigger input | The event map sent with trackImmediately | Customer app and campaign configuration |
| Campaign measurement | impression, click, dismiss | Engage Mobile SDK |
The SDK does not define a fixed list of business events such as purchase, add_to_cart, or search. Those names and their fields are customer-defined and must match the Realtime Personalization configuration.
trackImmediately sends an event map to Realtime Personalization when the app reaches a configured screen or action.
The SDK accepts the following field roles:
| Field role | Typical key | Definition |
|---|---|---|
| Event name | event | Customer-defined name for the trigger. |
| Screen or page context | screen_name | Customer-defined screen or page value. |
| Customer identity | customer_id, user_id, or td_client_id | Customer-defined identity key used for targeting or identity resolution. |
| Campaign attributes | Any JSON-serializable key | Customer-defined values used by Personalization rules or message content. |
Field names and data types must match the names configured in Realtime Personalization. The SDK forwards customer-defined fields; it does not create business fields automatically.
{
"event": "<CUSTOMER_DEFINED_EVENT>",
"screen_name": "<CUSTOMER_DEFINED_SCREEN>",
"customer_id": "<CUSTOMER_DEFINED_ID>",
"<CUSTOMER_DEFINED_FIELD>": "<VALUE>"
}Use only the fields required by the campaign. Do not include API keys, Personalization tokens, passwords, or unnecessary personal data.
When a campaign-delivered message is presented or used, the SDK can create these measurement events:
| Event | Meaning |
|---|---|
impression | The campaign message was presented. |
click | A supported link or Bridge action was used. |
dismiss | The campaign experience was closed. |
The message metadata and action fields for these events are defined by the SDK contract. See the Developer Guide's Mobile In-App Measurement and Engage Mobile SDK API and Event Reference pages.
A direct app call to openUrl is not a campaign offer and does not create these campaign measurement events.
If a campaign depends on a business action, the customer app must send the event and fields explicitly. The following names are examples, not SDK-standard events:
purchaseadd_to_cartsearchcontent_viewsignup- Any customer-defined event name
Define the event contract with the campaign owner, configure the matching fields in Realtime Personalization, and implement the event in the app.