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 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 seconds 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

{
    "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 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 seconds 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

{
    "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 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 seconds 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

{
    "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 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

{
    "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 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

{
    "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 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 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 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

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

Unsubscribe

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

sending_ip

string

IP 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"
}

Did this page help you?