Here you will find the list of all the transactional events you can track. Please consider the request schema and parameters for each of them when you decide to build the Notify URL on your side.
📘 Datetime parameters 🕗
The following parameters are present in most of the events we offer tracking for. Keep this information in mind whenever working with webhook datetime values.
ts_epoch
, ts_event
: UTC Timezone
date
: CET/CEST Timezone
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 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
JSON
{
"event":"request",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"ts_epoch": 1604933654,
"template_id": 22,
"tags": ["transac_messages"]
}
Attribute name Data type Description event
string "click" 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 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 link
string URL accessed by recipient
JSON
{
"event":"click",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"ts_epoch": 1604933654,
"template_id": 22,
"tags": ["transac_messages"],
"link": "https://domain.com/product"
}
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 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
JSON
{
"event":"deferred",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"ts_epoch": 1604933654,
"template_id": 22,
"tags": ["transac_messages"],
"reason": "spam"
}
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 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
JSON
{
"event":"delivered",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
}
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 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
JSON
{
"event":"soft_bounce",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
"reason": "server is down"
}
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 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
JSON
{
"event":"hard_bounce",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
"reason": "server is down",
"ts_epoch":1604933653
}
Attribute name Data type Description event
string "complaint" 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 event occurred X-Mailin-custom
string custom added header tag
array of strings tags you might have used to identify your message
JSON
{
"event":"complaint",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"X-Mailin-custom": "some_custom_header",
"tags": ["transac_messages"],
}
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 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
JSON
{
"event":"unique_opened",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
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 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
JSON
{
"event":"opened",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"sending_ip": "xxx.xxx.xxx.xxx",
"template_id": 22,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
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 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
JSON
{
"event":"invalid_email",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"template_id": 22,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
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 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
JSON
{
"event":"blocked",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"template_id": 22,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
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 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
JSON
{
"event":"invalid_email",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"template_id": 22,
"tags": ["transac_messages"],
"ts_epoch": 1604933623
}
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 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
JSON
{
"event":"unsubscribed",
"email": "[email protected] ",
"id": xxxxx,
"date": "2020-10-09 00:00:00",
"ts":1604933619,
"message-id": "[email protected] ",
"ts_event": 1604933654,
"subject": "My first Transactional",
"X-Mailin-custom": "some_custom_header",
"template_id": 22,
"tag":"[\"transactionalTag\"]",
"ts_epoch": 1604933623,
"sending_ip": "xxx.xxx.xxx.xxx"
}
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 template_id
integer internal id of the template
JSON
{
"event": "proxy_open",
"email": "[email protected] "
"id": 1,
"date": "2020-10-09 00:00:00",
"message-id": "[email protected] ".
"subject": "My first Transactional",
"tag": "[\"transactionalTag\"]",
"sending_ip": "xxx.xxx.xxx.xxx",
"s_epoch": 1534486682000,
"template_id": 1
}
Attribute name Datatype Description bounce_type
String Type of bounce occurred e.g. hard_bounce, soft_bounce date
String It shows the time in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND at which the callback is sent to client in his timezone. description
String Description of event occurred. It could be accepted, delivered, unsubscribed, replied etc. errorCode
Integer This code tells us the status of the SMS messageId
Integer Id of the Transactional SMS message that is sent msg_status
String Status of the SMS message which could be unsubscribed, replied, soft_bounce etc. reply
String Shows the content of the reply received by the recipient status
String Status of the webhook which will be ok by default tag
String SMS tag if the client has used any to
String Includes the contact number of the recipient ts_event
Integer it is the time at which the callback is sent to client in Unix format reference
String Every sms has an unique encoded string which is reference
JSON
"transactional_webhook": {
"body": {
"bounce_type": "",
"date": "2024-06-09 12:55:34",
"description": "accepted",
"errorCode": 0,
"messageId": 52932335915003,
"msg_status": "accepted",
"reference": {
"1": "hf0hhxatvatm5daofc"
},
"reply": "",
"status": "OK",
"tag": "",
"to": "33623964448",
"ts_event": 1717930521
},
}
📘 Transactional SMS webhook events
sent
accepted
delivered
unsubscribe
reply
softbounce
hardbounce