Your integration may add custom parameters. The tables only list parameters that exist in Synerise and SDKs/APIs by default.
## marketingAgreement.turnOn The email marketing agreement was enabled in a profile. **Default retention**: 30 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | ## marketingAgreement.turnOff The email marketing agreement was disabled in a profile. **Default retention**: 30 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | ## newsletter.unsubscribe The Synerise unsubscribe link (generated with the `{{ synerise-resign-link }}` insert) was used to unsubscribe from a newsletter. **Default retention**: 30 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | ID | string | `cfb1845c-6508-49c8-952d-b96fb7326ee5` | Unique ID of the newsletter campaign where the unsubscribe link was clicked | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | variantID/variantId | integer | `7044429` | Unique identifier of the message variant | | variantName | string | `Variant A` | Name of the message variant | | ignoreCapping | boolean | `true` | Informs if the communication was configured to ignore capping. | | Additional parameters | string | `Custom value` | Parameters added in the **Additional parameters** section of the campaign's settings | | label | string | `Check this promo!` | Name of the newsletter campaign where the unsubscribe link was clicked. This is **not** the same `label` parameter as the label parameter common to all events. | | method | string | `RESIGN_LINK` | Method of resignation. Possible values: `RESIGN_LINK` if the resignation link in email template was clicked, `ONECLICK_LINK` or `ONECLICK_MAILTO` if the recipient clicked the unsubscribe button displayed by mail client.| ## message.send An email was sent to a profile. **Default retention**: 90 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | campaignSubject | string | `Monthly message` | Title (subject) of the message. | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | variantID/variantId | integer | `7044429` | Unique identifier of the message variant | | variantName | string | `Variant A` | Name of the message variant | | sender | object | {"accountId":1234} | Account ID of the sender account; can be used to [enrich the event](/docs/assets/events/adding-event-parameters#enriching-events-with-data-from-catalogs) with sender details, such as the name. | | 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. | | id | string | `44a5938a-098c-4bd3-b7dd-cda405ee76a1` | Unique ID of the message | | journeyId | string | `db0a9db2-8849-5c58-9871-e07d45d64bd7` | Unique ID of the 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 workflow that caused this event (if applicable) | | Additional parameters | string | `Custom value` | Parameters added in the **Additional parameters** section of the campaign's settings | | title | string | `Monthly newsletter` | Title (subject) of the message. | | isAlert | boolean | `true` | Only added when the message was caused by a workflow. When `true`, it was caused by an [SMS](/docs/automation/actions/sms-alert-node) or [Email](/docs/automation/actions/send-email-alert-node) Alert node. | | messageOrigin | string | `AUTOMATION` | Informs if the the message was caused by a workflow in Automation Hub or by Experience Hub. | ## newsletter.capping An email was not sent due to message limits set for this type of communication.
If messages are sent through Automation Hub, 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](/docs/assets/events/event-reference/common-parameters#base-parameters) | | cappingType | string | `AUTOMATION_EMAIL` | The type of communication activity where the capping occurred. Possible values: `AUTOMATION_EMAIL`, `CAMPAIGN_EMAIL`, `TAG`; if the capping happened in Automation Hub, the `journeyId` and `diagramId` are added to the parameters. If the capping is related to a tag, `cappedTagIds` is added to the parameters. | | cappingLimit | integer | `4` | Limit of how many messages can be sent in the defined period | | cappingPeriod | integer | `86400` | Capping period, in seconds | | cappedTagIds | array | `[2a185433-aa26-43bf-9aef-67342091b489]` | IDs of tags for which the communication limit has been reached. | | cappedTagNames | array | ["churn","loyalty"] | Names of tags for which the communication limit has been reached. | | ignoreCapping | boolean | `true` | Informs if the communication was configured to ignore capping. | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | campaignSubject | string | `Monthly message` | Title (subject) of the message. | | variantID/variantId | integer | `7044429` | Unique identifier of the message variant | | journeyId | string | `db0a9db2-8849-5c58-9871-e07d45d64bd7` | Unique ID of the 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 workflow that caused this event (if applicable) | | testDelivery | boolean | `true` | Informs if the message was sent as a communication test. | | Additional parameters | string | `Custom value` | Parameters added in the **Additional parameters** section of the campaign's settings | ## newsletter.controlGroup An email 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](/docs/assets/events/event-reference/common-parameters#base-parameters) | | id | string | `c8f0b875-62e9-4dae-b9d5-241cbc9453b3` | Unique ID of the campaign | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | variantName | string | `Variant A` | Name of the message variant | | variantID/variantId | integer | `7044429` | Unique identifier of the message variant | | journeyId | string | `db0a9db2-8849-5c58-9871-e07d45d64bd7` | Unique ID of the 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 workflow that caused this event (if applicable) | | 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. | | 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. | | globalControlGroupId | string | `00000000-0000-0000-0000-000000000001` | Parameter reserved for future purposes. | | Additional parameters | string | `Custom value` | Parameters added in the **Additional parameters** section of the campaign's settings | ## message.skipped An email 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](/docs/assets/events/event-reference/common-parameters#base-parameters) | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | campaignSubject | string | `Monthly message` | Title (subject) of the message. | | id | string | `c8f0b875-62e9-4dae-b9d5-241cbc9453b3` | Unique ID of the campaign | | variantName | string | `Variant A` | Name of the message variant | | 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. | | Additional parameters | string | `Custom value` | Parameters added in the **Additional parameters** section of the campaign's settings | ## newsletter.open This event is generated only when a recipient opens a regular email. Opening test and alert emails does not generate this event. **Default retention**: 90 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | id | string | `c8f0b875-62e9-4dae-b9d5-241cbc9453b3` | Unique ID of the campaign | | campaignTitle | string | `Monthly newsletter` | Title of the campaign in Experience Hub | | url | string | `https://web.snrbox.com/pix.gif?...` | The URL of the pixel that enables event tracking inside the message. This pixel is added automatically when the message is sent. | | campaignName | string | `Black Friday promotions` | Title of the campaign in Experience Hub | | variantID/variantId | integer | `7044429` | Unique identifier of the message variant | | variantName | string | `Variant A` | Name of the message variant | | journeyId | string | `db0a9db2-8849-5c58-9871-e07d45d64bd7` | Unique ID of the 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 workflow that caused this event (if applicable) | | testDelivery | boolean | `false` | For the newsletter.open event, this parameter is always set to false.
Informs if the message was sent as a communication test. | | ignoreCapping | boolean | `true` | Informs if the communication was configured to ignore capping. | | Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, [some parameters are added automatically](/docs/assets/events/event-reference/common-parameters#parameters-added-by-web-sdk). | | Additional parameters | string | `Custom value` | Parameters added in the **Additional parameters** section of the campaign's settings | ## newsletter.click This event is generated only when a recipient clicks a link a regular email. Clicking links in test and alert emails does not generate this event. **Default retention**: 90 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | id | string | `44a5938a-098c-4bd3-b7dd-cda405ee76a1` | Unique ID of the message | | campaignTitle | string | `Monthly newsletter` | Title of the campaign in Experience Hub | | url | string | `https://web.snrbox.com/pix.gif?...` | The URL of the link that was clicked. | | campaignName | string | `Black Friday promotions` | Title of the campaign in Experience Hub | | variantID/variantId | integer | `7044429` | Unique identifier of the message variant | | variantName | string | `Variant A` | Name of the message variant | | journeyId | string | `db0a9db2-8849-5c58-9871-e07d45d64bd7` | Unique ID of the 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 workflow that caused this event (if applicable) | | Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, [some parameters are added automatically](/docs/assets/events/event-reference/common-parameters#parameters-added-by-web-sdk). | | ignoreCapping | boolean | `true` | Informs if the communication was configured to ignore capping. | | Additional parameters | string | `Custom value` | Parameters added in the **Additional parameters** section of the campaign's settings | | testDelivery | boolean | `false` | For the newsletter.click event, this parameter is always set to false.
Informs if the message was sent as a communication test. | | messageOrigin | string | `AUTOMATION` | Informs if the the message was caused by a workflow in Automation Hub or by Experience Hub. | ## message.notSent An email was not sent. Check the parameters to locate the reason.
When a message can't be sent, it still counts towards [communication limits](/docs/settings/configuration/campaign-limits)!
**Default retention**: 30 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | info | string | `message too old` | A description of why the message was not sent. The content of this parameter may come from your email provider or from the [`terminate`](/developers/inserts/insert-usage#stopping-communication-from-rendering) insert. | | extra | string | `Missing currentStep value` | Additional information about the Jinjava problem that stopped the message from sending. | | exception | string | `Syntax error in {% endfor %}: Mismatched end tag, expected: endif` | Additional information about a problem that stopped the communication from sending. | | id | string | `44a5938a-098c-4bd3-b7dd-cda405ee76a1` | Unique ID of the message | | ignoreCapping | boolean | `true` | Informs if the communication was configured to ignore capping. | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | campaignSubject | string | `Monthly message` | Title (subject) of the message. | | variantID/variantId | integer | `7044429` | Unique identifier of the message variant | | sender | object | {"accountId":1234} | Account ID of the sender account; can be used to [enrich the event](/docs/assets/events/adding-event-parameters#enriching-events-with-data-from-catalogs) with sender details, such as the name. | | testDelivery | boolean | `true` | Informs if the message was sent as a communication test. | | journeyId | string | `db0a9db2-8849-5c58-9871-e07d45d64bd7` | Unique ID of the 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 workflow that caused this event (if applicable) | | Additional parameters | string | `Custom value` | Parameters added in the **Additional parameters** section of the campaign's settings | | title | string | `Monthly newsletter` | Title (subject) of the message. | | isAlert | boolean | `true` | Only added when the message was caused by a workflow. When `true`, it was caused by an [SMS](/docs/automation/actions/sms-alert-node) or [Email](/docs/automation/actions/send-email-alert-node) Alert node. | | messageOrigin | string | `AUTOMATION` | Informs if the the message was caused by a workflow in Automation Hub or by Experience Hub. | ## newsletter.dropped The recipient's email address is on the denylist. This event is generated only when the SMTP provider supports it. **Default retention**: 30 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | id | string | `44a5938a-098c-4bd3-b7dd-cda405ee76a1` | Unique ID of the message | ## newsletter.hardbounce An email was not delivered because the email address is invalid or the recipient blocked receiving emails. This event is generated only when the SMTP provider supports it. **Default retention**: 90 days | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | id | string | `44a5938a-098c-4bd3-b7dd-cda405ee76a1` | Unique ID of the message | ## newsletter.softbounce An email was not delivered due to an overloaded inbox, server error, or email size. This event is generated only when the SMTP provider supports it. **Default retention**: 90 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | id | string | `44a5938a-098c-4bd3-b7dd-cda405ee76a1` | Unique ID of the message | ## newsletter.spambounce The recipient's email server recognized the message as potential spam. The email is rejected and **not saved**, even in the spam folder. This event is generated only when the SMTP provider supports it. **Default retention**: 90 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | Base parameters | various | n/a | [Parameters that may exist in all events](/docs/assets/events/event-reference/common-parameters#base-parameters) | | campaignName | string | `Black Friday promotions` | Name of the communication campaign | | id | string | `44a5938a-098c-4bd3-b7dd-cda405ee76a1` | Unique ID of the message |