Email events

Note: 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 exist in all events

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 exist in all events

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 exist in all events
ID string cfb1845c-6508-49c8-952d-b96fb7326ee5 Unique ID of the newsletter campaign where the unsubscribe link was clicked
variantID/variantId integer 7044429 Unique identifier of the message variant
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.

message.send

An email was sent to a profile.

Default retention: 90 days

Parameter Type Example Description
Base parameters various n/a Parameters that exist in all events
campaignSubject string Monthly newsletter Title (subject) of the message. Added to this event since Jan 12, 2024.
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
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 Automation journey that caused this event (if applicable)
diagramId string c819738e-2d61-482c-a680-75ebdbc9a762 Unique ID of the Automation 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.

newsletter.capping

An email was not sent due to message limits set for this type of communication.

Default retention: 30 days

Parameter Type Example Description
Base parameters various n/a Parameters that exist in all events
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.
cappingLimit integer 4 Limit of how many messages can be sent in the defined period
cappingPeriod integer 86400 Capping period, in seconds
ignoreCapping boolean true Informs if the communication was configured to ignore capping. Added to this event since Jan 23, 2024.
campaignName string Black Friday promotions Name of the communication campaign
campaignSubject string Monthly newsletter Title (subject) of the message. 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.
journeyId string db0a9db2-8849-5c58-9871-e07d45d64bd7 Unique ID of the Automation journey that caused this event (if applicable)
diagramId string c819738e-2d61-482c-a680-75ebdbc9a762 Unique ID of the Automation workflow that caused this event (if applicable)
testDelivery boolean true Informs if the message was sent as a communication test. 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

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 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.
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 Automation journey that caused this event (if applicable)
diagramId string c819738e-2d61-482c-a680-75ebdbc9a762 Unique ID of the Automation 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. 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.
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. Added to this event since Jan 23, 2024.

newsletter.open

An email was opened by a recipient.

Default retention: 90 days

Parameter Type Example Description
Base parameters various n/a Parameters that exist in all events
id string 44a5938a-098c-4bd3-b7dd-cda405ee76a1 Unique ID of the message
campaignTitle string Monthly newsletter Title of the campaign in the Communication module
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.
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 Automation journey that caused this event (if applicable)
diagramId string c819738e-2d61-482c-a680-75ebdbc9a762 Unique ID of the Automation workflow that caused this event (if applicable)
testDelivery boolean true Informs if the message was sent as a communication test.
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.
Additional parameters string Custom value Parameters added in the Additional parameters section of the campaign's settings

newsletter.click

A recipient clicked a link in an email.

Default retention: 90 days

Parameter Type Example Description
Base parameters various n/a Parameters that exist in all events
id string 44a5938a-098c-4bd3-b7dd-cda405ee76a1 Unique ID of the message
campaignTitle string Monthly newsletter Title of the campaign in the Communication module
url string https://web.snrbox.com/pix.gif?... The URL of the link that was clicked.
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 Automation journey that caused this event (if applicable)
diagramId string c819738e-2d61-482c-a680-75ebdbc9a762 Unique ID of the Automation 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.
Additional parameters string Custom value Parameters added in the Additional parameters section of the campaign's settings

message.notSent

An email 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 exist in all events
info string message too old A description of why the message was not send. The content of this parameter may come from your email provider.
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 newsletter Title (subject) of the message. Added to this event since Jan 12, 2024.
variantID/variantId integer 7044429 Unique identifier 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.
journeyId string db0a9db2-8849-5c58-9871-e07d45d64bd7 Unique ID of the Automation journey that caused this event (if applicable)
diagramId string c819738e-2d61-482c-a680-75ebdbc9a762 Unique ID of the Automation 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.

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 exist in all events
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 exist in all events
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 exist in all events
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 exist in all events
campaignName string Black Friday promotions Name of the communication campaign
id string 44a5938a-098c-4bd3-b7dd-cda405ee76a1 Unique ID of the message
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker