In-app messaging events
Note: Your integration may add custom parameters. The tables only list parameters that exist in Synerise and SDKs/APIs by default.
inApp.show
An in-app message was shown.
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/variantId | integer | 7044429 |
Unique identifier of the message variant |
| 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/variantId | integer | 7044429 |
Unique identifier of the message variant |
| 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.
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/variantId | integer | 7044429 |
Unique identifier of the message variant |
| 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. |
| 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 |
| 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 |
Parameter reserved for future purposes. |
inApp.discard
An in-app message was closed.
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/variantId | integer | 7044429 |
Unique identifier of the message variant |
| 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 JS method in the in-app. When application, it was closed by using the Mobile SDK method. |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings |
inApp.hide
An in-app message was hidden.
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/variantId | integer | 7044429 |
Unique identifier of the message variant |
| 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/variantId | integer | 7044429 |
Unique identifier of the message variant |
| 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 cause, for example, by 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/variantId | integer | 7044429 |
Unique identifier of the message variant |
| 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 |
