Transactional webhooks

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



Sent

Attribute nameData typeDescription
eventstring"request"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
mirror_linkstringA preview link corresponding to the UI logs for the event
contact_idintegerBrevo identifier for an existing contact. If contact is not present , return 0
{
	"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"]
}

Clicked

Attribute nameData typeDescription
eventstring"click"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
linkstringURL accessed by recipient
user_agentstringInformation about the user’s browser or email client
device_usedstringDetails about the device from which the action originated
contact_idintegerBrevo identifier for an existing contact. If contact is not present , return 0
mirror_linkstringA preview link corresponding to the UI logs for the event
{
	"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"
}

Deferred

Attribute nameData typeDescription
eventstring"deferred"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
reasonstringthe reason the message has been deferred
{
	"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"
}

Delivered

Attribute nameData typeDescription
eventstring"delivered"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
ts_epochintegertime stamp in milliseconds UTC of when message was sent
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
{
	"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"],
}

Soft bounced

Attribute nameData typeDescription
eventstring"soft_bounce"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
reasonstringthe reason the message has been soft bounced
{
	"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"
}

Hard bounced

Attribute nameData typeDescription
eventstring"hard_bounce"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
reasonstringthe reason the message has been soft bounced
ts_epochintegertime stamp in milliseconds UTC of when message was sent
{
	"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 
}

Spam

Attribute nameData typeDescription
eventstring"spam"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
X-Mailin-customstringcustom added header
tagsarray of stringstags you might have used to identify your message
{
	"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"],
}

First opening

Attribute nameData typeDescription
eventstring"unique_opened"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
user_agentstringInformation about the user’s browser or email client
device_usedstringDetails about the device from which the action originated
mirror_linkstringA preview link corresponding to the UI logs for the event
contact_idintegerBrevo identifier for an existing contact. If its not present , return 0
{
	"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
}

Opened

Attribute nameData typeDescription
eventstring"opened"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
user_agentstringInformation about the user’s browser or email client
device_usedstringDetails about the device from which the action originated
contact_idintegerBrevo identifier for an existing contact. If its not present , return 0
mirror_linkstringA preview link corresponding to the UI logs for the event
{
	"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
}

Invalid email

Attribute nameData typeDescription
eventstring"invalid_email"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
{
	"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
}

Blocked

Attribute nameData typeDescription
eventstring"blocked"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
{
	"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
}

Error

Attribute nameData typeDescription
eventstring"error"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
{
	"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
}

Unsubscribed

Attribute nameData typeDescription
eventstring"unsubscribed"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
tsintegertimestamp in seconds of when event occurred
message-idstringinternal message id
ts_eventintegertime stamp in seconds GMT of when event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
template_idintegerinternal id of the template
tagstringtag you might have used to identify your message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
sending_ipstringIP used to send the message
user_agentstringInformation about the user’s browser or email client
device_usedstringDetails about the device from which the action originated
mirror_linkstringA preview link corresponding to the UI logs for the event
contact_idintegerBrevo identifier for an existing contact. If its not present , return 0
{
	"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"
}

Proxy open

Attribute nameData typeDescription
eventstring"proxy_open"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
message-idstringinternal message id
subjectstringmessage subject
tagstringtag you might have used to identify your message
sending_ipstringIP used to send the message
ts_epochintegertime stamp in milliseconds UTC of when message was sent
ts_eventintegerit is the time at which the callback is sent to client in Unix format
template_idintegerinternal id of the template
user_agentstringInformation about the user’s browser or email client
device_usedstringDetails about the device from which the action originated
mirror_linkstringA preview link corresponding to the UI logs for the event
contact_idintegerBrevo identifier for an existing contact. If its not present , return 0
{
	"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
}

Unique proxy open

Attribute nameData typeDescription
eventstring"unique_proxy_open"
emailstringrecipient of message
idintegerwebhook id
datestringdate sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
message-idstringinternal message id
subjectstringmessage subject
tagstringtag you might have used to identify your message
sending_ipstringIP used to send the message
tsintegertimestamp in seconds of when event occurred
ts_epochintegertime stamp in milliseconds UTC of when message was sent
ts_eventintegerit is the time at which the callback is sent to client in Unix format
template_idintegerinternal id of the template
linkstringURL accessed by recipient
mirror_linkstringA preview link corresponding to the UI logs for the event
tagsarray of stringstags you might have used to identify your message
user_agentstringInformation about the user’s browser or email client
device_usedstringDetails about the device from which the action originated
contact_idintegerBrevo identifier for an existing contact. If its not present , return 0
sender_emailstringEmail of the sender
{
   "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
}

Transactional SMS payload

Attribute nameDatatypeDescription
bounce_typeStringType of bounce occurred e.g. hard_bounce, soft_bounce
dateStringIt shows the time in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND at which the callback is sent to client in his timezone.
descriptionStringDescription of event occurred. It could be accepted, delivered, unsubscribed, replied etc.
errorCodeIntegerThis code tells us the status of the SMS
messageIdIntegerId of the Transactional SMS message that is sent
msg_statusStringStatus of the SMS message which could be unsubscribed, replied, soft_bounce etc.
replyStringShows the content of the reply received by the recipient
statusStringStatus of the webhook which will be ok by default
tagStringSMS tag if the client has used any
toStringIncludes the contact number of the recipient
ts_eventIntegerit is the time at which the callback is sent to client in Unix format
referenceStringEvery sms has an unique encoded string which is reference
"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