SMS events
Note: Your integration may add custom parameters. The tables only list parameters that exist in Synerise and SDKs/APIs by default.
sms.send
An SMS was sent to a profile.
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 |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantID/variantId | integer | 7044429 |
Unique identifier of the message variant |
| testDelivery | boolean | true |
Informs if the message was sent as a communication test. |
| ignoreCapping | boolean | true |
Informs if the communication was configured to ignore capping. |
| journeyId | string | db0a9db2-8849-5c58-9871-e07d45d64bd7 |
Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, journeyId is the same, because it's the same workflow. |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable) |
sms.notSent
An SMS was not sent. Check the parameters to locate the reason.
Important: When a message can’t be sent, it still counts towards communication limits!
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 |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantID/variantId | integer | 7044429 |
Unique identifier of the message variant. Added to this event since Jan 12, 2024. |
| info | string | Body is empty |
Content of the error message from Synerise or the SMS provider |
| testDelivery | boolean | true |
Informs if the message was sent as a communication test. |
| ignoreCapping | boolean | true |
Informs if the communication was configured to ignore capping. |
| journeyId | string | db0a9db2-8849-5c58-9871-e07d45d64bd7 |
Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, journeyId is the same, because it's the same workflow. |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable) |
sms.capping
An SMS was not sent due to message limits for this type of communication in the workspace settings (not related to capping for a particular automation).
WARNING: If messages are sent through the Automation module, this event may be generated for customers who do not have the required marketing agreement for receiving this message type. This is because the sending process checks the limits before the customers’ agreement status.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| id | string | db47c241-f093-4488-b3a0-1c1d7f69ed89 |
Unique ID of the SMS campaign created by the Automation engine |
| cappingLimit | integer | 4 |
Limit of how many messages can be sent in the defined period |
| cappingPeriod | integer | 86400 |
Capping period, in seconds |
| cappingType | string | AUTOMATION_EMAIL |
The type of communication activity where the capping occurred. If the capping happened in Automation, the journeyId and diagramId are added to the parameters. |
| ignoreCapping | boolean | true |
Informs if the communication was configured to ignore capping. Added to this event since Jan 23, 2024. |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable) |
| journeyId | string | db0a9db2-8849-5c58-9871-e07d45d64bd7 |
Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, journeyId is the same, because it's the same workflow. |
| campaignName | string | Black Friday promotions |
Name of the communication campaign. Added to this event since Jan 23, 2024. |
| variantID/variantId | integer | 7044429 |
Unique identifier of the message variant. Added to this event since Jan 23, 2024. |
| testDelivery | boolean | true |
Informs if the message was sent as a communication test. Added to this event since Jan 23, 2024. |
sms.click
A link in an SMS was clicked.
To collect these events, the link must be inserted with {% preparelink%}. See Creating SMS templates.
Note: This event isn’t generated for test deliveries.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| URL/url | string | https://www.shop.pl/gaming/consoles/worse-than-pc-256gb-white?gclid=EAIaIQobChMIo66d4564th547AYASAAEgI_MvD_BwE |
URL of the site where the event occurred |
| campaignTitle | string | Monthly newsletter |
Title of the campaign in the Communication module |
| campaignName | string | Black Friday promotions |
Name of the communication campaign |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantName | string | Variant A |
Name of the message variant |
| testDelivery | boolean | true |
Informs if the message was sent as a communication test. |
| ignoreCapping | boolean | true |
Informs if the communication was configured to ignore capping. |
| journeyId | string | db0a9db2-8849-5c58-9871-e07d45d64bd7 |
Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, journeyId is the same, because it's the same workflow. |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable) |
| snrs_medium | string | email |
The communication medium (for example email, webpush) |
| ua.os.family | string | Mac OS X |
Operating system of the source device |
| ua.os.major | string | 10 |
Major version of the user's operating system |
| ua.device.family | string | Other |
The client device family |
| ua.device.brand | string | Brandname |
Brand name of the device. Only sent by mobiles and tablets. |
| ua.device.model | string | Model 8 |
Model of the device. Only sent by mobiles and tablets. |
| ua.family | string | Apple Mail |
User Agent family; value of this parameter may contain the name of the bot which clicked the link in the message. You can use this parameter in analytics by excluding sms.click events where the user agent name indicates a bot |
| userAgent | string | Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) |
Information about the User Agent |
| ua.major | string | 605 |
Major UA version number |
| ua.minor | string | 15 |
Minor UA version number |
| ua.patch | string | 15 |
The patch version of the User Agent |
sms.controlGroup
An SMS was was not sent 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 |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| campaignName | string | Black Friday promotions |
Name of the communication campaign. Added to this event since Jan 23, 2024. |
| variantID/variantId | integer | 7044429 |
Unique identifier of the message variant |
| variantName | string | Variant A |
Name of the message variant |
| 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. |
| globalControlGroupId | string | 00000000-0000-0000-0000-000000000001 |
Parameter reserved for future purposes. |
| testDelivery | boolean | true |
Informs if the message was sent as a communication test. Added to this event since Jan 23, 2024. |
| ignoreCapping | boolean | true |
Informs if the communication was configured to ignore capping. Added to this event since Jan 23, 2024. |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings. Added to this event since Jan 23, 2024. |
sms.skipped
An SMS was not sent because Silence Hours were active. If the process of sending multiple messages overlaps with Silence Hours, sending is stopped in progress.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignTitle | string | Monthly newsletter |
Title of the campaign in the Communication module |
| campaignName | string | Black Friday promotions |
Name of the communication campaign. Added to this event since Jan 12, 2024. |
| id | string | c8f0b875-62e9-4dae-b9d5-241cbc9453b3 |
Unique ID of the campaign |
| variantID/variantId | integer | 7044429 |
Unique identifier of the message variant |
| variantName | string | Variant A |
Name of the message variant. Added to this event since Jan 12, 2024. |
| testDelivery | boolean | true |
Informs if the message was sent as a communication test. Added to this event since Jan 12, 2024. |
| ignoreCapping | boolean | true |
Informs if the communication was configured to ignore capping. Added to this event since Jan 12, 2024. |
| journeyId | string | db0a9db2-8849-5c58-9871-e07d45d64bd7 |
Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, journeyId is the same, because it's the same workflow. Added to this event since Jan 12, 2024. |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable). Added to this event since Jan 12, 2024. |
| Additional parameters | string | Custom value |
Parameters added in the Additional parameters section of the campaign's settings. Added to this event since Jan 12, 2024. |
