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 eventstring "request" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message ts_epochinteger time stamp in milliseconds UTC of when message was sent template_idinteger internal id of the template tagsarray 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 eventstring "click" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message ts_epochinteger time stamp in milliseconds UTC of when message was sent template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message linkstring 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 eventstring "deferred" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message ts_epochinteger time stamp in milliseconds UTC of when message was sent template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message reasonstring 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 eventstring "delivered" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray 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 eventstring "soft_bounce" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message reasonstring 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 eventstring "hard_bounce" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message reasonstring the reason the message has been soft bounced ts_epochinteger 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 eventstring "complaint" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred X-Mailin-customstring custom added header tagarray 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 eventstring "unique_opened" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger 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 eventstring "opened" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header sending_ipstring ip used to send message template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger 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 eventstring "invalid_email" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger 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 eventstring "blocked" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger 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 eventstring "error" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header template_idinteger internal id of the template tagsarray of strings tags you might have used to identify your message ts_epochinteger 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 eventstring "unsubscribed" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone tsinteger timestamp in seconds of when event occurred message-idstring internal message id ts_eventinteger time stamp in seconds GMT of when event occurred subjectstring message subject X-Mailin-customstring custom added header template_idinteger internal id of the template tagstring tag you might have used to identify your message ts_epochinteger 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 eventstring "proxy_open" emailstring recipient of message idinteger webhook id datestring date sent listed in YEAR-MONTH-DAY, HOUR:MINUTE:SECOND in your timezone message-idstring internal message id subjectstring message subject tagstring tag you might have used to identify your message sending_ipstring IP used to send the message ts_epochinteger time stamp in milliseconds UTC of when message was sent template_idinteger 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
}
