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 yo build the Notify URL on your side.




πŸ“˜

Datetime parameters πŸ•—

The following parameters are present in all 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



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 event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
ts_epochintegertime stamp in seconds UTC of when message was sent
template_idintegerinternal id of the template
tagsarray of stringstags you might have used to identify your message
{
    "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"]
}

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 event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
ts_epochintegertime stamp in seconds 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
{
    "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"
}

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 event occurred
subjectstringmessage subject
X-Mailin-customstringcustom added header
sending_ipstringip used to send message
ts_epochintegertime stamp in seconds 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": "[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"
}

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 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
{
    "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"],
}

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 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": "[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"
}

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 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 seconds UTC of when message was sent
{
    "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 
}

Complaint

Attribute nameData typeDescription
eventstring"complaint"
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 event occurred
X-Mailin-customstringcustom added header
tagarray of stringstags you might have used to identify your message
{
    "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"],
}

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 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 seconds UTC of when message was sent
{
    "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
}

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 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 seconds UTC of when message was sent
{
    "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
}

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 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 seconds UTC of when message was sent
{
    "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
}

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 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 seconds UTC of when message was sent
{
    "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
}

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 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 seconds UTC of when message was sent
{
    "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
}

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 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 seconds UTC of when message was sent
sending_ipstringIP used to send the message
{
    "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"
}

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 seconds UTC of when message was sent
template_idintegerinternal id of the template
{
    "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
}