Here you will find the list of all the transactional events you can track. Please consider the request schema and parameters for each of them when you decide to build the Notify URL on your side.
📘 Datetime parameters 🕗
The following parameters are present in most of the events we offer tracking for. Keep this information in mind whenever working with webhook datetime values.
ts_epoch, ts_event : UTC Timezone date : CET/CEST Timezone
Attribute name Data type Description eventstring "request" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message ts_epochinteger time stamp in milliseconds UTC of when message was sent template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message mirror_linkstring A preview link corresponding to the UI logs for the event contact_idinteger Brevo identifier for an existing contact. If contact is not present , return 0
JSON
{
"event":"request",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"ts_epoch": 1604933654,
"template_id": 22,
"mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
"contact_id": 8,
"tags": ["transac_messages"]
}
Attribute name Data type Description eventstring "click" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message ts_epochinteger time stamp in milliseconds UTC of when message was sent template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message linkstring URL accessed by recipient user_agentstring Information about the user’s browser or email client device_usedstring Details about the device from which the action originated contact_idinteger Brevo identifier for an existing contact. If contact is not present , return 0 mirror_linkstring A preview link corresponding to the UI logs for the event
JSON
{
"event":"click",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"ts_epoch": 1604933654,
"template_id": 22,
"tags": ["transac_messages"],
"user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"device_used": "DESKTOP",
"mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
"contact_id": 8,
"link": "https://domain.com/product"
}
Attribute name Data type Description eventstring "deferred" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message ts_epochinteger time stamp in milliseconds UTC of when message was sent template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message reasonstring the reason the message has been deferred
JSON
{
"event":"deferred",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"ts_epoch": 1604933654,
"template_id": 22,
"tags": ["transac_messages"],
"reason": "spam"
}
Attribute name Data type Description eventstring "delivered" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred ts_epochinteger time stamp in milliseconds UTC of when message was sent subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message
JSON
{
"event":"delivered",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
}
Attribute name Data type Description eventstring "soft_bounce" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message reasonstring the reason the message has been soft bounced
JSON
{
"event":"soft_bounce",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
"reason": "server is down"
}
Attribute name Data type Description eventstring "hard_bounce" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message reasonstring the reason the message has been soft bounced ts_epochinteger time stamp in milliseconds UTC of when message was sent
JSON
{
"event":"hard_bounce",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
"reason": "server is down",
"ts_epoch":1604933653
}
Attribute name Data type Description eventstring "spam" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred X-Mailin-customstring custom added header tagsarray of strings tags you might have used to identify your message
JSON
{
"event":"spam",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"X-Mailin-custom": "some_custom_header",
"tags": ["transac_messages"],
}
Attribute name Data type Description eventstring "unique_opened" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger time stamp in milliseconds UTC of when message was sent user_agentstring Information about the user’s browser or email client device_usedstring Details about the device from which the action originated mirror_linkstring A preview link corresponding to the UI logs for the event contact_idinteger Brevo identifier for an existing contact. If its not present , return 0
JSON
{
"event":"unique_opened",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
"user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"device_used": "DESKTOP",
"mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
"contact_id": 8,
"ts_epoch": 1604933623
}
Attribute name Data type Description eventstring "opened" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger time stamp in milliseconds UTC of when message was sent user_agentstring Information about the user’s browser or email client device_usedstring Details about the device from which the action originated contact_idinteger Brevo identifier for an existing contact. If its not present , return 0 mirror_linkstring A preview link corresponding to the UI logs for the event
JSON
{
"event":"opened",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"device_used": "DESKTOP",
"mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
"contact_id": 8,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
Attribute name Data type Description eventstring "invalid_email" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger time stamp in milliseconds UTC of when message was sent
JSON
{
"event":"invalid_email",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"template_id": 22,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
Attribute name Data type Description eventstring "blocked" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger time stamp in milliseconds UTC of when message was sent
JSON
{
"event":"blocked",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"template_id": 22,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
Attribute name Data type Description eventstring "error" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger time stamp in milliseconds UTC of when message was sent
JSON
{
"event":"invalid_email",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"template_id": 22,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
Attribute name Data type Description eventstring "unsubscribed" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header template_idinteger internal id of the template tagstring tag you might have used to identify your message ts_epochinteger time stamp in milliseconds UTC of when message was sent sending_ipstring IP used to send the message user_agentstring Information about the user’s browser or email client device_usedstring Details about the device from which the action originated mirror_linkstring A preview link corresponding to the UI logs for the event contact_idinteger Brevo identifier for an existing contact. If its not present , return 0
JSON
{
"event":"unsubscribed",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"template_id": 22,
"tag":"[\"transactionalTag\"]",
"user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"device_used": "MOBILE",
"mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
"contact_id": 8,
"ts_epoch": 1604933623,
"sending_ip": "xxx.xxx.xxx.xxx"
}
Attribute name Data type Description eventstring "proxy_open" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone message-idstring internal message id subjectstring message subject tagstring tag you might have used to identify your message sending_ipstring IP used to send the message ts_epochinteger time stamp in milliseconds UTC of when message was sent ts_eventinteger it is the time at which the callback is sent to client in Unix format template_idinteger internal id of the template user_agentstring Information about the user’s browser or email client device_usedstring Details about the device from which the action originated mirror_linkstring A preview link corresponding to the UI logs for the event contact_idinteger Brevo identifier for an existing contact. If its not present , return 0
JSON
{
"event": "proxy_open",
"email": "[email protected] "
"id": 1,
"date": "2020-10-09 00:00:00",
"message-id": "[email protected] ".
"subject": "My first Transactional",
"tag": "[\"transactionalTag\"]",
"sending_ip": "xxx.xxx.xxx.xxx",
"ts_epoch": 1534486682000,
"user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"device_used": "DESKTOP",
"mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
"contact_id": 8,
"template_id": 1
}
Attribute name Data type Description eventstring "unique_proxy_open" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone message-idstring internal message id subjectstring message subject tagstring tag you might have used to identify your message sending_ipstring IP used to send the message tsinteger timestamp in seconds of when event occurred ts_epochinteger time stamp in milliseconds UTC of when message was sent ts_eventinteger it is the time at which the callback is sent to client in Unix format template_idinteger internal id of the template linkstring URL accessed by recipient mirror_linkstring A preview link corresponding to the UI logs for the event tagsarray of strings tags you might have used to identify your message user_agentstring Information about the user’s browser or email client device_usedstring Details about the device from which the action originated contact_idinteger Brevo identifier for an existing contact. If its not present , return 0 sender_emailstring Email of the sender
JSON
{
"id":25290,
"email":"",
"message-id":"an#2705147202202651768",
"date":"2024-08-22 16:03:29",
"tags":[
"this_tag",
"tag_thos"
],
"tag":"[\"this_tag\", \"tag_thos\"]",
"event":"unique_proxy_open",
"subject":"this is required subject",
"sending ip":"::",
"ts":1724322809,
"template_id":660,
"ts_epoch":1724322809710,
"ts_event":1724322809,
"link":"",
"sender_email":"[email protected] ",
"mirror_link":"https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
"user_agent":"Mozilla/5.0",
"device_used":"DESKTOP",
"contact_id":4816445214646337536
}
Attribute name Datatype Description bounce_typeString Type of bounce occurred e.g. hard_bounce, soft_bounce dateString It shows the time in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND at which the callback is sent to client in his timezone. descriptionString Description of event occurred. It could be accepted, delivered, unsubscribed, replied etc. errorCodeInteger This code tells us the status of the SMS messageIdInteger Id of the Transactional SMS message that is sent msg_statusString Status of the SMS message which could be unsubscribed, replied, soft_bounce etc. replyString Shows the content of the reply received by the recipient statusString Status of the webhook which will be ok by default tagString SMS tag if the client has used any toString Includes the contact number of the recipient ts_eventInteger it is the time at which the callback is sent to client in Unix format referenceString Every sms has an unique encoded string which is reference
JSON
"transactional_webhook": {
"body": {
"bounce_type": "",
"date": "2024-06-09 12:55:34",
"description": "accepted",
"errorCode": 0,
"messageId": 52932335915003,
"msg_status": "accepted",
"reference": {
"1": "hf0hhxatvatm5daofc"
},
"reply": "",
"status": "OK",
"tag": "",
"to": "33623964448",
"ts_event": 1717930521
},
}
📘 Transactional SMS webhook events
sent
accepted
delivered
unsubscribe
reply
softbounce
hardbounce
