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.
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 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
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
{
"id": 26570,
"to": "918076001713",
"sms_count": 1,
"credits_used": 1.5,
"messageId": 123,
"remaining_credit": 11488.845,
"msg_status": "sent",
"date": "2024-10-11 14:19:59",
"type": "transactional"
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
}
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)
{
"id": 26519,
"msg_status": "accepted",
"status": "OK",
"description": "accepted",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
"to": "12018500757",
"ts_event": 1728390414,
"date": "2024-10-08 17:56:54",
"messageId": 123,
"tag": [
"tag1name","tag2name"
],
"type": "transactional"
}
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)
{
"id": 26527,
"status": "OK",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
"msg_status": "delivered",
"description": "delivered",
"to": "919102600071",
"ts_event": 1728459617,
"date": "2024-10-09 13:10:17",
"messageId": 123,
"tag": [
"tag1name"
],
"type": "transactional"
}
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)
{
"id": 26519,
"msg_status": "replied",
"status": "OK",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
"error_code": 101,
"description": "replied",
"to": "919368207022",
"reply": "Hi",
"ts_event": 1728386415,
"date": "2024-10-08 16:50:16",
"messageId": 123,
"tag": [
"tag1name","tag2name"
],
"type": "transactional",
}
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)
{
"id": 26519,
"msg_status": "soft_bounce",
"status": "OK",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
"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",
"messageId": 123,
"tag": [
"tag1name","tag2name"
],
"type": "transactional"
}
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)
{
"id": 26519,
"msg_status": "hard_bounce",
"status": "OK",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
"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 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)
{
"id": 26519,
"msg_status": "subscribe",
"status": "OK",
"description": "subscribe",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
"to": "12010077757",
"error_code": 101,
"ts_event": 1728390414,
"date": "2024-10-08 17:56:54",
"messageId": 123,
"tag": [
"tag1name","tag2name"
],
"type": "transactional"
}
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)
{
"id": 26519,
"msg_status": "unsubscribed",
"status": "OK",
"description": "unsubscribed",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
"to": "12018570057",
"ts_event": 1728390414,
"date": "2024-10-08 17:56:54",
"messageId": 123,
"error_code": 100,
"tag": [
"tag1name","tag2name"
],
"type": "transactional"
}
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)
{
"id": 26519,
"msg_status": "skip",
"status": "OK",
"description": "skip",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
   },
"to": "00018577757",
"ts_event": 1728390414,
"date": "2024-10-08 17:56:54",
"messageId": 0,
"tag": [
"tag1name","tag2name"
],
"type": "transactional"
}
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
{
"id": 26570,
"to": "918076721713",
"messageId": 123,
"msg_status": "bl",
"date": "2024-10-11 14:19:59",
"type": "transactional",
"reference":{
      "1":"1hi8srff049z0qzvgt3f"
},
}
