This page lists all transactional events you can track. Review the request schema and parameters for each event when building your Notify URL.

Transactional Email events

Transactional SMS events

Datetime parameters 🕗

The following parameters appear in most tracked events. Keep this in mind when working with webhook datetime values.

ts_epoch, ts_event: UTC Timezone date: CET/CEST Timezone

Transactional Email

Sent

Attribute name	Data type	Description
`event`	string	”request”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`sending_ip`	string	ip used to send message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`mirror_link`	string	A preview link corresponding to the UI logs for the event
`contact_id`	integer	Brevo identifier for an existing contact. If contact is not present , return 0

1 {
2 	"event":"request",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10   "X-Mailin-custom": "some_custom_header",
11   "sending_ip": "xxx.xxx.xxx.xxx",
12   "ts_epoch": 1604933654,
13   "template_id": 22,
14   "mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
15   "contact_id": 8,
16   "tags": ["transac_messages"]
17 }

Clicked

Attribute name	Data type	Description
`event`	string	”click”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date of the event listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`sending_ip`	string	ip used to send message
`ts_epoch`	integer	time stamp in milliseconds UTC of when event occurred
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`link`	string	URL accessed by recipient
`user_agent`	string	Information about the user’s browser or email client
`device_used`	string	Details about the device from which the action originated
`contact_id`	integer	Brevo identifier for an existing contact. If contact is not present , return 0
`mirror_link`	string	A preview link corresponding to the UI logs for the event

1 {
2 	"event":"click",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10   "X-Mailin-custom": "some_custom_header",
11   "sending_ip": "xxx.xxx.xxx.xxx",
12   "ts_epoch": 1604933654,
13   "template_id": 22,
14   "tags": ["transac_messages"],
15   "user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
16   "device_used": "DESKTOP",
17   "mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
18   "contact_id": 8,
19   "link": "https://domain.com/product"
20 }

Deferred

Attribute name	Data type	Description
`event`	string	”deferred”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`sending_ip`	string	ip used to send message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`reason`	string	the reason the message has been deferred

1 {
2 	"event":"deferred",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "sending_ip": "xxx.xxx.xxx.xxx",
12   "ts_epoch": 1604933654,
13   "template_id": 22,
14   "tags": ["transac_messages"],
15   "reason": "spam"
16 }

Delivered

Attribute name	Data type	Description
`event`	string	”delivered”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`sending_ip`	string	ip used to send message
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message

1 {
2 	"event":"delivered",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "sending_ip": "xxx.xxx.xxx.xxx",
12   "template_id": 22,
13   "tags": ["transac_messages"],
14 }

Soft bounced

Attribute name	Data type	Description
`event`	string	”soft_bounce”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`sending_ip`	string	ip used to send message
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`reason`	string	the reason the message has been soft bounced

1 {
2 	"event":"soft_bounce",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "sending_ip": "xxx.xxx.xxx.xxx",
12   "template_id": 22,
13   "tags": ["transac_messages"],
14   "reason": "server is down"
15 }

Hard bounced

Attribute name	Data type	Description
`event`	string	”hard_bounce”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`sending_ip`	string	ip used to send message
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`reason`	string	the reason the message has been soft bounced
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent

1 {
2 	"event":"hard_bounce",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "sending_ip": "xxx.xxx.xxx.xxx",
12   "template_id": 22,
13   "tags": ["transac_messages"],
14   "reason": "server is down",
15   "ts_epoch":1604933653 
16 }

Spam

Attribute name	Data type	Description
`event`	string	”spam”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`X-Mailin-custom`	string	custom added header
`tags`	array of strings	tags you might have used to identify your message

1 {
2 	"event":"spam",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9 	"X-Mailin-custom": "some_custom_header",
10   "tags": ["transac_messages"],
11 }

First opening

Attribute name	Data type	Description
`event`	string	”unique_opened”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`sending_ip`	string	ip used to send message
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent
`user_agent`	string	Information about the user’s browser or email client
`device_used`	string	Details about the device from which the action originated
`mirror_link`	string	A preview link corresponding to the UI logs for the event
`contact_id`	integer	Brevo identifier for an existing contact. If its not present , return 0

1 {
2 	"event":"unique_opened",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "sending_ip": "xxx.xxx.xxx.xxx",
12   "template_id": 22,
13   "tags": ["transac_messages"],
14   "user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
15  	"device_used": "DESKTOP",
16   "mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
17   "contact_id": 8,
18   "ts_epoch": 1604933623
19 }

Opened

Attribute name	Data type	Description
`event`	string	”opened”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`sending_ip`	string	ip used to send message
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent
`user_agent`	string	Information about the user’s browser or email client
`device_used`	string	Details about the device from which the action originated
`contact_id`	integer	Brevo identifier for an existing contact. If its not present , return 0
`mirror_link`	string	A preview link corresponding to the UI logs for the event

1 {
2 	"event":"opened",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "sending_ip": "xxx.xxx.xxx.xxx",
12   "template_id": 22,
13   "user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
14  	"device_used": "DESKTOP",
15   "mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
16   "contact_id": 8,
17   "tags": ["transac_messages"],
18   "ts_epoch": 1604933623
19 }

Invalid email

Attribute name	Data type	Description
`event`	string	”invalid_email”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent

1 {
2 	"event":"invalid_email",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "template_id": 22,
12   "tags": ["transac_messages"],
13   "ts_epoch": 1604933623
14 }

Blocked

Attribute name	Data type	Description
`event`	string	”blocked”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent

1 {
2 	"event":"blocked",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "template_id": 22,
12   "tags": ["transac_messages"],
13   "ts_epoch": 1604933623
14 }

Error

Attribute name	Data type	Description
`event`	string	”error”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`template_id`	integer	internal id of the template
`tags`	array of strings	tags you might have used to identify your message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent

1 {
2 	"event":"invalid_email",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "template_id": 22,
12   "tags": ["transac_messages"],
13   "ts_epoch": 1604933623
14 }

Unsubscribed

Attribute name	Data type	Description
`event`	string	”unsubscribed”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`ts`	integer	timestamp in seconds of when event occurred
`message-id`	string	internal message id
`ts_event`	integer	time stamp in seconds GMT of when the webhook event occurred
`subject`	string	message subject
`X-Mailin-custom`	string	custom added header
`template_id`	integer	internal id of the template
`tag`	string	tag you might have used to identify your message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent
`sending_ip`	string	IP used to send the message
`user_agent`	string	Information about the user’s browser or email client
`device_used`	string	Details about the device from which the action originated
`mirror_link`	string	A preview link corresponding to the UI logs for the event
`contact_id`	integer	Brevo identifier for an existing contact. If its not present , return 0

1 {
2 	"event":"unsubscribed",
3   "email": "example@domain.com",
4   "id": xxxxx,
5   "date": "2020-10-09 00:00:00",
6   "ts":1604933619,
7   "message-id": "201798300811.5787683@relay.domain.com",
8   "ts_event": 1604933654,
9   "subject": "My first Transactional",
10 	"X-Mailin-custom": "some_custom_header",
11   "template_id": 22,
12   "tag":"[\"transactionalTag\"]",
13   "user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
14   "device_used": "MOBILE",
15   "mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
16   "contact_id": 8,
17   "ts_epoch": 1604933623,
18   "sending_ip": "xxx.xxx.xxx.xxx"
19 }

Proxy open

Attribute name	Data type	Description
`event`	string	”proxy_open”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`message-id`	string	internal message id
`subject`	string	message subject
`tag`	string	tag you might have used to identify your message
`sending_ip`	string	IP used to send the message
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent
`ts_event`	integer	it is the time at which the callback is sent to client in Unix format
`template_id`	integer	internal id of the template
`user_agent`	string	Information about the user’s browser or email client
`device_used`	string	Details about the device from which the action originated
`mirror_link`	string	A preview link corresponding to the UI logs for the event
`contact_id`	integer	Brevo identifier for an existing contact. If its not present , return 0

1 {
2 	"event": "proxy_open",
3 	"email": "example@domain.com"
4 	"id": 1,
5 	"date": "2020-10-09 00:00:00",
6 	"message-id": "201798300811.5787683@relay.domain.com".
7 	"subject": "My first Transactional",
8 	"tag": "[\"transactionalTag\"]",
9 	"sending_ip": "xxx.xxx.xxx.xxx",
10 	"ts_epoch": 1534486682000,
11   "user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
12   "device_used": "DESKTOP",
13   "mirror_link": "https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
14   "contact_id": 8,
15 	"template_id": 1
16 }

Unique proxy open

Attribute name	Data type	Description
`event`	string	”unique_proxy_open”
`email`	string	recipient of message
`id`	integer	webhook id
`date`	string	date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone
`message-id`	string	internal message id
`subject`	string	message subject
`tag`	string	tag you might have used to identify your message
`sending_ip`	string	IP used to send the message
`ts`	integer	timestamp in seconds of when event occurred
`ts_epoch`	integer	time stamp in milliseconds UTC of when message was sent
`ts_event`	integer	it is the time at which the callback is sent to client in Unix format
`template_id`	integer	internal id of the template
`link`	string	URL accessed by recipient
`mirror_link`	string	A preview link corresponding to the UI logs for the event
`tags`	array of strings	tags you might have used to identify your message
`user_agent`	string	Information about the user’s browser or email client
`device_used`	string	Details about the device from which the action originated
`contact_id`	integer	Brevo identifier for an existing contact. If its not present , return 0
`sender_email`	string	Email of the sender

1 {
2    "id":25290,
3    "email":"",
4    "message-id":"an#2705147202202651768",
5    "date":"2024-08-22 16:03:29",
6    "tags":[
7       "this_tag",
8       "tag_thos"
9    ],
10    "tag":"[\"this_tag\", \"tag_thos\"]",
11    "event":"unique_proxy_open",
12    "subject":"this is required subject",
13    "sending ip":"::",
14    "ts":1724322809,
15    "template_id":660,
16    "ts_epoch":1724322809710,
17    "ts_event":1724322809,
18    "link":"",
19    "sender_email":"abc@sendinblue.com",
20    "mirror_link":"https://app-smtp.brevo.com/log/preview/1a2000f4-4e33-23aa-ab68-900dxxx9152c",
21    "user_agent":"Mozilla/5.0",
22    "device_used":"DESKTOP",
23    "contact_id":4816445214646337536
24 }

Transactional SMS

Parameters and webhook responses for each event are listed below. The Transactional SMS webhook events are:

Sent

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`to`	String	Mobile number of the recipient
`sms_count`	Integer	Number of sms parts sent
`credits_used`	Float	Credits deducted
`messageId`	Integer	Message id for Transactional SMS
`remaining_credit`	Float	Remaining balance credit
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`date`	String	Time at which the event is generated
`type`	String	Type of SMS (Marketing/Transactional)
`reference`	String	id generated for every Transactional SMS

1 {
2 	"id": 26570,
3 	"to": "918076001713",
4 	"sms_count": 1,
5 	"credits_used": 1.5,
6   "messageId": 123,
7 	"remaining_credit": 11488.845,
8 	"msg_status": "sent",
9 	"date": "2024-10-11 14:19:59",
10 	"type": "transactional"
11   "reference":{
12       "1":"1hi8srff049z0qzvgt3f"
13    },
14 }

Accepted

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`status`	String	Status
`description`	String	Describes the event i.e delivered, accepted, replied etc.
`reference`	String	id generated for every Transactional SMS
`to`	String	Mobile number of the recipient
`ts_event`	String	it is the time at which the callback is sent to client in Unix format
`date`	String	Time at which the event is generated
`messageId`	Integer	Message Id for Transactional SMS
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26519,
3 	"msg_status": "accepted",
4   "status": "OK",
5 	"description": "accepted",
6   "reference":{
7       "1":"1hi8srff049z0qzvgt3f"
8    },
9 	"to": "12018500757",
10 	"ts_event": 1728390414,
11 	"date": "2024-10-08 17:56:54",
12 	"messageId": 123,
13 	"tag": [
14 	"tag1name","tag2name"
15 	],
16 	"type": "transactional"
17 }

Delivered

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`status`	String	Status
`reference`	String	id generated for every Transactional SMS
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`description`	String	Describes the event i.e delivered, accepted, replied etc.
`to`	String	Mobile number of the recipient
`ts_event`	Integer	It is the time at which the callback is sent to client in Unix format
`date`	String	Time at which the event is generated
`messageId`	Integer	Message id of Transactional SMS
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26527,
3 	"status": "OK",
4   "reference":{
5       "1":"1hi8srff049z0qzvgt3f"
6    },
7 	"msg_status": "delivered",
8 	"description": "delivered",
9 	"to": "919102600071",
10 	"ts_event": 1728459617,
11 	"date": "2024-10-09 13:10:17",
12   "messageId": 123,
13 	"tag": [
14 	"tag1name"
15 	],
16 	"type": "transactional"
17 }

Replied

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`status`	String	Status
`reference`	String	id generated for every Transactional SMS
`error_code`	Integer	Error code
`description`	String	Bounce Reason for Failed to deliver message
`to`	String	Mobile number of the recipient
`reply`	String	Reply of SMS
`ts_event`	Integer	It is the time at which the callback is sent to client in Unix format
`date`	String	Time at which the event is generated
`messageId`	Integer	Message id for Transactional SMS
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26519,
3 	"msg_status": "replied",
4 	"status": "OK",
5 	"reference":{
6       "1":"1hi8srff049z0qzvgt3f"
7    },
8 	"error_code": 101,
9 	"description": "replied",
10 	"to": "919368207022",
11 	"reply": "Hi",
12 	"ts_event": 1728386415,
13 	"date": "2024-10-08 16:50:16",
14 	"messageId": 123,
15 	"tag": [
16 	"tag1name","tag2name"
17 	],
18 	
19 	"type": "transactional",
20 }

Soft bounce

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`status`	String	Status
`reference`	String	id generated for every Transactional SMS
`description`	String	Bounce reason for failed to deliver message
`bounce_type`	String	Hard bounce or soft bounce
`error_code`	Integer	Error code
`to`	String	Mobile number of the recipient
`ts_event`	Integer	It is the time at which the callback is sent to client in Unix format
`date`	String	Time at which the event is generated
`messageId`	Integer	Message id for Transactional SMS
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26519,
3 	"msg_status": "soft_bounce",
4   "status": "OK",
5   "reference":{
6       "1":"1hi8srff049z0qzvgt3f"
7    },
8 	"description": "Failed to deliver message for reasons unknown",
9 	"bounce_type": "soft_bounce",
10 	"error_code": 7,
11 	"to": "916778670023",
12 	"ts_event": 1728390422,
13 	"date": "2024-10-08 17:57:03",
14   "messageId": 123,
15 	"tag": [
16 	"tag1name","tag2name"
17 	],
18 	"type": "transactional"
19 }

Hard bounce

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`status`	String	Status
`reference`	String	id generated for every Transactional SMS
`description`	String	Bounce reason for failed to deliver message
`bounce_type`	String	Hard bounce or soft bounce
`error_code`	Integer	Error code
`messageId`	Integer	Message Id for Transactional SMS
`to`	String	Mobile number of the recipient
`ts_event`	Integer	It is the time at which the callback is sent to client in Unix format
`date`	String	Time at which the event is generated
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26519,
3 	"msg_status": "hard_bounce",
4   "status": "OK",
5   "reference":{
6       "1":"1hi8srff049z0qzvgt3f"
7    },
8 	"description": "Message is undeliverable due to an incorrect / invalid / permanently barred MSISDN for this operator",
9 	"bounce_type": "hard_bounce",
10 	"error_code": 23,
11 	"messageId": 123,
12 	"to": "916008678623",
13 	"ts_event": 1728390422,
14 	"date": "2024-10-08 17:57:03",
15 	"tag": [
16 	"tag1name","tag2name"
17 	],
18 	"type": "transactional"
19 }

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`status`	String	Status
`description`	String	Describes the event i.e delivered, accepted, replied etc.
`reference`	String	id generated for every Transactional SMS
`to`	String	Mobile number of the recipient
`error_code`	Integer	Error code
`ts_event`	Integer	It is the time at which the callback is sent to client in Unix format
`date`	String	Time at which the event is generated
`messageId`	Integer	Message Id for Transactional SMS
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26519,
3 	"msg_status": "subscribe",
4   "status": "OK",
5 	"description": "subscribe",
6   "reference":{
7       "1":"1hi8srff049z0qzvgt3f"
8    },
9 	"to": "12010077757",
10 	"error_code": 101,
11 	"ts_event": 1728390414,
12 	"date": "2024-10-08 17:56:54",
13 	"messageId": 123,
14 	"tag": [
15 	"tag1name","tag2name"
16 	],
17 	"type": "transactional"
18 }

Unsubscribe

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`status`	String	Status
`description`	String	Describes the event i.e delivered, accepted, replied etc.
`reference`	String	id generated for every Transactional SMS
`to`	String	Mobile number of the recipient
`ts_event`	Integer	It is the time at which the callback is sent to client in Unix format
`date`	String	Time at which the event is generated
`messageId`	Integer	Message Id for Transactional SMS
`error_code`	Integer	Error code
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26519,
3 	"msg_status": "unsubscribed",
4   "status": "OK",
5 	"description": "unsubscribed",
6   "reference":{
7       "1":"1hi8srff049z0qzvgt3f"
8    },
9 	"to": "12018570057",
10 	"ts_event": 1728390414,
11 	"date": "2024-10-08 17:56:54",
12 	"messageId": 123,
13 	"error_code": 100,
14 	"tag": [
15 	"tag1name","tag2name"
16 	],
17 	"type": "transactional"
18 }

Skip

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`status`	String	Status
`description`	String	Describes the event i.e delivered, accepted, replied etc.
`reference`	String	id generated for every Transactional SMS
`to`	String	Mobile number of the recipient
`ts_event`	Integer	It is the time at which the callback is sent to client in Unix format
`date`	String	Time at which the event is generated
`messageId`	Integer	Message Id for Transactional SMS
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26519,
3 	"msg_status": "skip",
4   "status": "OK",
5 	"description": "skip",
6   "reference":{
7       "1":"1hi8srff049z0qzvgt3f"
8    },
9 	"to": "00018577757",
10 	"ts_event": 1728390414,
11 	"date": "2024-10-08 17:56:54",
12 	"messageId": 0,
13 	"tag": [
14 	"tag1name","tag2name"
15 	],
16 	"type": "transactional"
17 }

Blacklisted

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`to`	String	Mobile number of the recipient
`messageId`	Integer	Message Id for Transactional SMS
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`date`	String	Time at which the event is generated
`type`	String	Type of SMS (Marketing/Transactional)
`reference`	String	id generated for every Transactional SMS

1 {
2 "id": 26570,
3 "to": "918076721713",
4 "messageId": 123,
5 "msg_status": "bl",
6 "date": "2024-10-11 14:19:59",
7 "type": "transactional",
8 "reference":{
9       "1":"1hi8srff049z0qzvgt3f"
10 },
11 }

Rejected

Attribute name	Datatype	Description
`id`	Integer	The id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
`msg_status`	String	Status of the message(sent, delivered, soft_bounce, hard_bounce)
`status`	String	Status of webhook request
`reference`	String	id generated for every Transactional SMS
`to`	String	Mobile number of the recipient
`date`	String	Time at which the event is generated
`messageId`	Integer	Message Id for Transactional SMS
`tag`	Array of strings	SMS tag if the client has used any
`type`	String	Type of SMS (Marketing/Transactional)

1 {
2 	"id": 26519,
3 	"msg_status": "rej",
4 	"status": "OK",
5 	"reference":{
6       "1":"1hissrff04ss0qzv003f"
7    },
8  	"to": "12000500757",
9 	"date": "2024-10-08 17:56:54",
10 	"messageId": 123,
11 	"tag": [
12 	"tag1name","tag2name"
13 	],
14 	"type": "transactional",
15 }

Datetime parameters 🕗

Transactional Email

Sent

Clicked

Deferred

Delivered

Soft bounced

Hard bounced

Spam

First opening

Opened

Invalid email

Blocked

Error

Unsubscribed

Proxy open

Unique proxy open

Transactional SMS

Sent

Accepted

Delivered

Replied

Soft bounce

Hard bounce

Subscribe

Unsubscribe

Skip

Blacklisted

Rejected