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.

Transactional Email events

Transactional SMS events



📘

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


Transactional Email

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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook event occurred
X-Mailin-customstringcustom added header
tagsarray of stringstags you might have used to identify your message
{
	"event":"spam",
  "email": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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 the webhook 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": "example@domain.com",
  "id": xxxxx,
  "date": "2020-10-09 00:00:00",
  "ts":1604933619,
  "message-id": "201798300811.5787683@relay.domain.com",
  "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": "example@domain.com"
	"id": 1,
	"date": "2020-10-09 00:00:00",
	"message-id": "201798300811.5787683@relay.domain.com".
	"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":"abc@sendinblue.com",
   "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

The parameters and webhook responses for the webhook events are mentioned here. Below you will find all the Transactional SMS webhook events:

Sent

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
toStringMobile number of the recipient
sms_countIntegerNumber of sms parts sent
credits_usedFloatCredits deducted
remaining_creditFloatRemaining balance credit
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
dateStringTime at which the event is generated
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26570,
	"to": "918076001713",
	"sms_count": 1,
	"credits_used": 1.5,
	"remaining_credit": 11488.845,
	"msg_status": "sent",
	"date": "2024-10-11 14:19:59",
	"type": "transactional"
}

Accepted

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
toStringMobile number of the recipient
ts_eventStringit is the time at which the callback is sent to client in Unix format
dateStringTime at which the event is generated
messageIdIntegerMessage Id for Transactional SMS
tagArray of stringsSMS tag if the client has used any
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26519,
	"msg_status": "accepted",
	"description": "accepted",
	"to": "12018500757",
	"ts_event": 1728390414,
	"date": "2024-10-08 17:56:54",
	"messageId": 123,
	"tag": [
	"tag1name","tag2name"
	],
	"type": "transactional"
}

Delivered

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
statusStringStatus
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
toStringMobile number of the recipient
ts_eventIntegerIt is the time at which the callback is sent to client in Unix format
dateStringTime at which the event is generated
tagArray of stringsSMS tag if the client has used any
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26527,
	"status": "OK",
	"msg_status": "delivered",
	"description": "delivered",
	"to": "919102600071",
	"ts_event": 1728459617,
	"date": "2024-10-09 13:10:17",
	"tag": [
	"tag1name"
	],
	"type": "transactional"
}

Replied

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
error_codeIntegerError code
descriptionStringBounce Reason for Failed to deliver message
toStringMobile number of the recipient
replyStringReply of SMS
ts_eventIntegerIt is the time at which the callback is sent to client in Unix format
dateStringTime at which the event is generated
tagArray of stringsSMS tag if the client has used any
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26519,
	"msg_status": "replied",
	"error_code": 101,
	"description": "replied",
	"to": "919368200022",
	"reply": "Hi",
	"ts_event": 1728386415,
	"date": "2024-10-08 16:50:16",
	"tag": [
	"tag1name","tag2name"
	],
	"type": "transactional"
}

Soft bounce

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
descriptionStringBounce reason for failed to deliver message
bounce_typeStringHard bounce or soft bounce
error_codeIntegerError code
toStringMobile number of the recipient
ts_eventIntegerIt is the time at which the callback is sent to client in Unix format
dateStringTime at which the event is generated
tagArray of stringsSMS tag if the client has used any
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26519,
	"msg_status": "soft_bounce",
	"description": "Failed to deliver message for reasons unknown",
	"bounce_type": "soft_bounce",
	"error_code": 7,
	"to": "916778670023",
	"ts_event": 1728390422,
	"date": "2024-10-08 17:57:03",
	"tag": [
	"tag1name","tag2name"
	],
	"type": "transactional"
}

Hard bounce

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
descriptionStringBounce reason for failed to deliver message
bounce_typeStringHard bounce or soft bounce
error_codeIntegerError code
messageIdIntegerMessage Id for Transactional SMS
toStringMobile number of the recipient
ts_eventIntegerIt is the time at which the callback is sent to client in Unix format
dateStringTime at which the event is generated
tagArray of stringsSMS tag if the client has used any
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26519,
	"msg_status": "hard_bounce",
	"description": "Message is undeliverable due to an incorrect / invalid / permanently barred MSISDN for this operator",
	"bounce_type": "hard_bounce",
	"error_code": 23,
	"messageId": 123,
	"to": "916008678623",
	"ts_event": 1728390422,
	"date": "2024-10-08 17:57:03",
	"tag": [
	"tag1name","tag2name"
	],
	"type": "transactional"
}

Subscribe

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
toStringMobile number of the recipient
error_codeIntegerError code
ts_eventIntegerIt is the time at which the callback is sent to client in Unix format
dateStringTime at which the event is generated
messageIdIntegerMessage Id for Transactional SMS
tagArray of stringsSMS tag if the client has used any
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26519,
	"msg_status": "subscribe",
	"description": "subscribe",
	"to": "12010077757",
	"error_code": 101,
	"ts_event": 1728390414,
	"date": "2024-10-08 17:56:54",
	"messageId": 123,
	"tag": [
	"tag1name","tag2name"
	],
	"type": "transactional"
}

Unsubscribe

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
toStringMobile number of the recipient
ts_eventIntegerIt is the time at which the callback is sent to client in Unix format
dateStringTime at which the event is generated
messageIdIntegerMessage Id for Transactional SMS
error_codeIntegerError code
tagArray of stringsSMS tag if the client has used any
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26519,
	"msg_status": "unsubscribed",
	"description": "unsubscribed",
	"to": "12018570057",
	"ts_event": 1728390414,
	"date": "2024-10-08 17:56:54",
	"messageId": 123,
	"error_code": 100,
	"tag": [
	"tag1name","tag2name"
	],
	"type": "transactional"
}

Skip

Attribute nameDatatypeDescription
idIntegerUnique id generated for each payload
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
toStringMobile number of the recipient
ts_eventIntegerIt is the time at which the callback is sent to client in Unix format
dateStringTime at which the event is generated
messageIdIntegerMessage Id for Transactional SMS
tagArray of stringsSMS tag if the client has used any
typeStringType of SMS (Marketing/Transactional)
{
	"id": 26519,
	"msg_status": "skip",
	"description": "skip",
	"to": "00018577757",
	"ts_event": 1728390414,
	"date": "2024-10-08 17:56:54",
	"messageId": 0,
	"tag": [
	"tag1name","tag2name"
	],
	"type": "transactional"
}