7 Events
7.1 Mailing delivery
7.1.1 testmail_delivered
Description
The testmail_delivered event occurs, when an admin or test mail has been successfully delivered to a recipient. The event is not triggered for normal mailings. (For normal mailings you have to use mailing_delivered.)
Please note: Delivery of a mailing is determined by the response of the mailbox provider. It depends on the mailbox provider, if the mail appears in the recipients inbox.
JSON data
{
"mailing_id" : <ID of mailing>,
"recipient_id" : <ID of recipient>,
"recipient_data" : {
<selected profile field data>
}
}
- mailing_id denotes the ID of the mailing
- recipient_id denotes the ID of the recipient, who received the mailing
- recipient_data contains a set of selected profile fields and its content
7.1.2 mail_delivered
Description
The mail_delivered event occurs, when a mail has been successfully delivered to a recipient. The event is not triggered for admin and test mailings. (For admin and test mailings you have to use testmail_delivered.)
Please note: Delivery of a mailing is determined by the response of the mailbox provider. It depends on the mailbox provider, if the mail appears in the recipients inbox.
JSON data
{
"mailing_id" : <ID of mailing>,
"recipient_id" : <ID of recipient>,
"recipient_data" : {
<selected profile field data>
}
}
- mailing_id denotes the ID of the mailing
- recipient_id denotes the ID of the recipient, who received the mailing
- recipient_data contains a set of selected profile fields and its content
7.1.3 hard_bounce
Description
The event hard_bounce indicates, that the mailing could not be sent to the recipient due to a permanent error (like unknown or invalid mail address).
JSON data
{
"mailing_id" : <ID of mailing>,
"recipeint_id" : <ID of recipent>,
"recipient_data" : {
<selected profile field data>
}
}
- mailing_id denotes the ID of the mailing
- recipient_id denotes the ID of the recipient
- recipient_data contains a set of selected profile fields and its content
7.1.4 mailing_delivery_complete
Description
This event indicates, that the mailing has been sent to all recipients and each mailing has either been delivered to its recipients or the delivery lead to a hard bounce (see hard_bounce event).
JSON data
- mailing_id denotes the ID of the mailing
7.2 Recipient reactions
7.2.1 link_clicked
Description
The link_clicked event occurs, when a recipients clicks on a link in a mailing.
Please note: Link click detection is only possible, if the link is trackable.
JSON data
{
"mailing_id" : <ID of mailing>,
"recipient_id" : <ID of recipient>,
"recipient_data" : {
<selected profile field data>
},
"link_id" : <ID of clicked link>
}
- mailing_id denotes the ID of the mailing
- recipient_id denotes the ID of the recipient, who opened the mailing
- recipient_data contains a set of selected profile fields and its content
- link_id denoted the ID of the clicked link
7.2.2 mail_opened
Description
The mail_opened event indicates, that a recipient has opened the mail in a mail client.
Please note: Measuring opening of mailings is only possible, if the mailing contains a tracking pixel.
JSON data
{
"mailing_id" : <ID of mailing>,
"recipient_id" : <ID of recipient>,
"recipient_data" : {
<selected profile field data>
}
}
- mailing_id denotes the ID of the mailing
- recipient_id denotes the ID of the recipient, who opened the mailing
- recipient_data contains a set of selected profile fields and its content
7.2.3 binding_changed
Description
The binding_changed event occurs, when the status of a recipient binding has changed.
Please note:
- No event is fired on imports or auto imports.
- In some cases, the property "mediatype" is not present or set to null.
JSON data
{
"mailinglist_id" : <ID of mailinglist>,
"mediatype" : <media type>,
"recipient_id" : <ID of recipient>,
"status" : <new status>,
"opt_out_by" : <opt out by>, // Only present for status "opt_out"
"recipient_data" : {
<selected profile field data>
}
}
- mailinglist_id denotes the ID of the mailing list
- mediatype denotes the media type (see Media types for list of valid values). May not present in some cases.
- recipient_id denotes the ID of the recipient
- status describes the user status (see User states for list of valid values)
- opt_out_by describes who opt-out the recipient (only present if status is "opt_out", values can be "recipient" or "admin")
- recipient_data contains a set of selected profile fields and its content.
7.2.4 profile_field_changed
Description
The profile_field_changed event occurs, when the value of a recipient profile field has been changed.
Please note:
- To be able to report a changed value of a profile field, this profile field has to be set to “include profile field in history”.
JSON data