NOTE: Your integration may add custom parameters. The tables only list parameters that exist in Synerise and SDKs/APIs by default.
IMPORTANT: The Android and iOS SDKs don't send the same parameters in all events:
- The Android SDK doesn't send
test_messageininApp.cappingandinApp.controlGroupevents. - The iOS SDK sends
test_messageand additional parameters only ininApp.capping,inApp.controlGroup,inApp.showandinApp.discardfor inline messages, andinApp.renderFailcaused by a rendering error on the backend. Other events sent by the iOS SDK don't include these parameters.
inApp.show
An in-app message was shown. For inline messages, this event is generated once per view.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| variantName | string | Variant A |
Name of the message variant |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantId | string | "f84141a7-c80a-49e7-b603-27cc83f4ca64" |
UUID of the generated message variant |
| inAppType | string | overlay |
Type of the in-app message: overlay or inline |
| test_message | boolean | true |
Indicates that the message was a test send |
| os | string | ios |
Operating system of the device |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |
inApp.capping
An in-app message was not displayed due to capping or frequency limits.
You can disable sending this event in the SDK Settings - Enable/disable sending in-app capping event.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| variantName | string | Variant A |
Name of the message variant |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantId | string | "f84141a7-c80a-49e7-b603-27cc83f4ca64" |
UUID of the generated message variant |
| inAppType | string | overlay |
Type of the in-app message: overlay or inline |
| test_message | boolean | true |
Indicates that the message was a test send. Not sent by the Android SDK in this event |
| os | string | ios |
Operating system of the device |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |
inApp.click
The content of an in-app message was tapped through openUrl, openDeeplink, or a link in the message content.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| variantName | string | Variant A |
Name of the message variant |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantId | string | "f84141a7-c80a-49e7-b603-27cc83f4ca64" |
UUID of the generated message variant |
| inAppType | string | overlay |
Type of the in-app message: overlay or inline |
| test_message | boolean | true |
Indicates that the message was a test send |
| url | string | https://example.com/details?test=true |
The URL that was accessed when the user interacted with the in-app. |
| type | string | deepLink |
The type of the clicked link: url for openUrl and http/https links, deepLink (Android) or deeplink (iOS) for openDeeplink and other links. |
| os | string | ios |
Operating system of the device |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |
inApp.controlGroup
An in-app message was not displayed because the recipient belongs to the control group.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| variantName | string | Variant A |
Name of the message variant |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| inAppType | string | overlay |
Type of the in-app message: overlay or inline |
| test_message | boolean | true |
Indicates that the message was a test send. Not sent by the Android SDK in this event |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |
| type | string | global |
Type of the control group. global if the global control group was used;campaign if the control group was defined in the campaign settings. |
| os | string | ios |
Operating system of the device |
| globalControlGroupId | string | 00000000-0000-0000-0000-000000000001 |
UUID of the global control group the profile was assigned to. Sent only when type is global |
inApp.discard
An in-app message was closed by SRInApp.close(), SRInApp.closeAndTrigger(), or by the application.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| variantName | string | Variant A |
Name of the message variant |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantId | string | "f84141a7-c80a-49e7-b603-27cc83f4ca64" |
UUID of the generated message variant |
| inAppType | string | overlay |
Type of the in-app message: overlay or inline |
| test_message | boolean | true |
Indicates that the message was a test send |
| os | string | ios |
Operating system of the device |
| closedBy | string | user |
Information about how the in-app was closed. When user, it was closed with the SRInApp.close() JS method in the in-app. When application (Android) or app (iOS), it was closed by the application using the Mobile SDK method. On Android, SRInApp.closeAndTrigger() also results in application |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |
inApp.hide
An overlay in-app message was hidden by the SRInApp.hide() method. This event applies to overlay messages only.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| variantName | string | Variant A |
Name of the message variant |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantId | string | "f84141a7-c80a-49e7-b603-27cc83f4ca64" |
UUID of the generated message variant |
| inAppType | string | overlay |
Type of the in-app message: overlay or inline |
| test_message | boolean | true |
Indicates that the message was a test send |
| os | string | ios |
Operating system of the device |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |
inApp.customHook
A custom action (implemented by your app developers and included in the in-app definition) from an in-app message was triggered.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| variantName | string | Variant A |
Name of the message variant |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantId | string | "f84141a7-c80a-49e7-b603-27cc83f4ca64" |
UUID of the generated message variant |
| inAppType | string | overlay |
Type of the in-app message: overlay or inline |
| test_message | boolean | true |
Indicates that the message was a test send |
| os | string | ios |
Operating system of the device |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |
inApp.renderFail
An in-app message was not displayed due to an error. This may be caused by the HTML not loading within renderingTimeout, an error in the Jinjava syntax, or a connection problem.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| variantName | string | Variant A |
Name of the message variant |
| error | string | Connection Issue: Socket closed |
Summary of the problem |
| info | string | Jinja rendering terminated by user |
Error message from the terminate insert |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantId | string | "f84141a7-c80a-49e7-b603-27cc83f4ca64" |
UUID of the generated message variant |
| inAppType | string | overlay |
Type of the in-app message: overlay or inline |
| test_message | boolean | true |
Indicates that the message was a test send |
| os | string | ios |
Operating system of the device |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |