For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Getting started
    • Overview
    • Quickstart
    • Authentication
    • Rate limits
  • Messaging API
    • Send transactional email
    • Send transactional SMS
    • Send transactional WhatsApp
  • Marketing Platform
    • Manage your contacts
    • Track website activity
    • Send WhatsApp campaigns
    • Weekly event exports
  • Webhooks
    • Getting started
    • Conversations webhooks
    • Payment webhooks
    • Marketing webhooks
    • Transactional webhooks
    • Loyalty webhooks
    • Batched webhooks
    • Secure webhook calls
    • Meetings and phone webhooks
    • Push notification webhooks
    • Sales CRM webhooks
  • Conversations
    • Getting started
    • Customize the chat widget
    • JavaScript API reference
    • REST API reference
    • Conversations webhooks
  • eCommerce
    • Activate eCommerce app
    • Manage product categories
    • Manage products
    • Manage orders
    • Coupon collections
    • eCommerce tracker events
  • Loyalty
    • Overview
    • Set up a program
    • Enroll members
    • Credit & debit points
    • Read member data
    • Best practices
  • Custom Objects
    • Custom objects management
  • Brevo tracker and events
    • Getting started
    • JavaScript implementation
    • REST implementation
    • Legacy tracker documentation
    • Events
  • Accounts and settings
    • Senders and domains
    • User activity logs
    • External feeds
    • Invited users
LogoLogo
Help CenterAPI KeysStatusSign In
On this page
  • 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
Webhooks

Transactional webhooks

Was this page helpful?
Previous

Loyalty webhooks

Real-time event reference for the Brevo Loyalty API.

Next
Built with

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

  • Sent
  • Clicked
  • Deferred
  • Delivered
  • Soft Bounced
  • Spam
  • First Opening
  • Hard Bounced
  • Opened
  • Invalid Email
  • Blocked
  • Error
  • Unsubscribed
  • Proxy Open
  • Unique Proxy Open

Transactional SMS events

  • Sent
  • Accepted
  • Delivered
  • Replied
  • Soft bounce
  • Hard bounce
  • Subscribe
  • Unsubscribe
  • Skip
  • Rejected


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 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
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 nameData typeDescription
eventstring”click”
emailstringrecipient of message
idintegerwebhook id
datestringdate of the event 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 event occurred
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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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
  • Accepted
  • Delivered
  • Replied
  • Soft bounce
  • Hard bounce
  • Subscribe
  • Unsubscribe
  • Skip
  • Blacklisted
  • Rejected

Sent

Attribute nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
toStringMobile number of the recipient
sms_countIntegerNumber of sms parts sent
credits_usedFloatCredits deducted
messageIdIntegerMessage id for Transactional SMS
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)
referenceStringid 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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
statusStringStatus
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
referenceStringid generated for every Transactional SMS
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)
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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
statusStringStatus
referenceStringid generated for every Transactional SMS
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 of Transactional SMS
tagArray of stringsSMS tag if the client has used any
typeStringType 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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
statusStringStatus
referenceStringid generated for every Transactional SMS
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
messageIdIntegerMessage id for Transactional SMS
tagArray of stringsSMS tag if the client has used any
typeStringType 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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
statusStringStatus
referenceStringid generated for every Transactional SMS
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
messageIdIntegerMessage id for Transactional SMS
tagArray of stringsSMS tag if the client has used any
typeStringType 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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
statusStringStatus
referenceStringid generated for every Transactional SMS
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)
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}

Subscribe

Attribute nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
statusStringStatus
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
referenceStringid generated for every Transactional SMS
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)
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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
statusStringStatus
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
referenceStringid generated for every 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
messageIdIntegerMessage Id for Transactional SMS
error_codeIntegerError code
tagArray of stringsSMS tag if the client has used any
typeStringType 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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
statusStringStatus
descriptionStringDescribes the event i.e delivered, accepted, replied etc.
referenceStringid generated for every 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
messageIdIntegerMessage Id for Transactional SMS
tagArray of stringsSMS tag if the client has used any
typeStringType 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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
toStringMobile number of the recipient
messageIdIntegerMessage Id for Transactional SMS
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
dateStringTime at which the event is generated
typeStringType of SMS (Marketing/Transactional)
referenceStringid 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 nameDatatypeDescription
idIntegerThe id is the webhook ID, so it will remain the same for webhook payloads sent to a single webhook URL
msg_statusStringStatus of the message(sent, delivered, soft_bounce, hard_bounce)
statusStringStatus of webhook request
referenceStringid generated for every Transactional SMS
toStringMobile number of the recipient
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)
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}