Marketing webhooks

Here you will find the list of all the marketing 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_sent, ts_event : UTC Timezone
date_sent, date_event : Local Timezone
date : CET/CEST Timezone



Marked as Spam

Attribute name

Data type

Description

event

string

"spam"

email

string

recipient email

id

integer

internal id of webhook

date_sent

string

date the campaign was sent (year-month-day, hour:minute:second)

date_event

string

date the event occurred (year-month-day, hour:minute:second)

ts_sent

integer

timestamp in seconds of when campaign was sent

ts_event

integer

timestamp in seconds of when event occurred

camp_id

integer

internal id of campaign

campaign_name

string

internal name of campaign

reason

string

spam reason

ts

integer

timestamp in seconds of when event occurred

tag

string

internal tag of campaign

{
  "id": xxxxxx,
  "camp_id": xx,
  "email": "[email protected]",
  "campaign name": "My First Campaign ",
  "date_sent": "2020-10-09 00:00:00",
  "date_event": "2020-10-09 00:00:00",
  "event": "spam",
  "reason": "undesired",
  "tag": "",
  "ts_sent": 1604933619,
  "ts_event": 1604933737,
  "ts": 1604937337
}

Opened

Attribute name

Data type

Description

event

string

"opened"

email

string

recipient email

id

integer

internal id of webhook

date_sent

string

date the campaign was sent (year-month-day, hour:minute:second)

date_event

string

date the event occurred (year-month-day, hour:minute:second)

ts_sent

integer

timestamp in seconds of when campaign was sent

ts_event

integer

timestamp in seconds of when event occurred

camp_id

integer

internal id of campaign

campaign name

string

internal name of campaign

tag

string

internal tag of campaign

ts

integer

timestamp in seconds of when event occurred

{
  "id": xxxxxx,
  "camp_id": xx,
  "email": "[email protected]",
  "campaign name": "My First Campaign",
  "date_sent": "2020-10-09 00:00:00",
  "date_event": "2020-10-09 00:00:00",
  "event": "opened",
  "tag": "",
  "ts_sent": 1604933619,
  "ts_event": 1604933737,
  "ts": 1604937337
}

Clicked

Attribute name

Data type

Description

event

string

"click"

email

string

recipient email

id

integer

internal id of webhook

date_sent

string

date the campaign was sent (year-month-day, hour:minute:second)

date_event

string

date the event occurred (year-month-day, hour:minute:second)

ts_sent

integer

timestamp in seconds of when campaign was sent

ts_event

integer

timestamp in seconds of when event occurred

camp_id

integer

internal id of campaign

campaign name

string

internal name of campaign

tag

string

internal tag of campaign

ts

integer

timestamp in seconds of when event occurred

URL

string

url clicked

{
  "id": xxxxxx,
  "camp_id": xx,
  "email": "[email protected]",
  "campaign name": "My First Campaign",
  "date_sent": "2020-10-09 00:00:00",
  "date_event": "2020-10-09 00:00:00",
  "event": "click",
  "tag": "",
  "ts_sent": 1604933619,
  "ts_event": 1604933737,
  "ts": 1604937337,
  "URL": "https://myCampaignUrl.net"
}

Hard Bounced

Attribute name

Data type

Description

event

string

"hard_bounce"

email

string

recipient email

id

integer

internal id of webhook

date_sent

string

date the campaign was sent (year-month-day, hour:minute:second)

date_event

string

date the event occurred (year-month-day, hour:minute:second)

ts_sent

integer

timestamp in seconds of when campaign was sent

ts_event

integer

timestamp in seconds of when event occurred

camp_id

integer

internal id of campaign

campaign name

string

internal name of campaign

sending_ip

string

ip used to send message

reason

string

hardbounce reason

ts

integer

timestamp in seconds of when event occurred

tag

string

internal tag of campaign

{
  "id": xxxxxx,
  "camp_id": xx,
  "email": "[email protected]",
  "campaign name": "My First Campaign",
  "date_sent": "2020-10-09 00:00:00",
  "date_event": "2020-10-09 00:00:00",
  "reason": "deferred",  
  "event": "hard_bounced",
  "tag": "",  
  "sending_ip": "xxx.xxx.xxx.xxx",
  "ts_sent": 1604933619,
  "ts_event": 1604933737,
  "ts": 1604937337,
}

Soft Bounced

Attribute type

Data type

Description

event

string

"soft_bounce"

email

string

recipient email

id

1integer

internal id of webhook

date_sent

string

date the campaign was sent (year-month-day, hour:minute:second)

date_event

string

date the event occurred (year-month-day, hour:minute:second)

ts_sent

integer

timestamp in seconds of when campaign was sent

ts_event

integer

timestamp in seconds of when event occurred

camp_id

integer

internal id of campaign

campaign name

string

internal name of campaign

reason

string

softbounce reason

sending_ip

string

ip used to send message

ts

integer

timestamp in seconds of when event occurred

tag

string

internal tag of campaign

{
  "id": xxxxxx,
  "camp_id": xx,
  "email": "[email protected]",
  "campaign name": "My First Campaign",
  "date_sent": "2020-10-09 00:00:00",
  "date_event": "2020-10-09 00:00:00",
  "reason": "deferred",  
  "event": "soft_bounced",
  "tag": "",
  "sending_ip": "xxx.xxx.xxx.xxx"
  "ts_sent": 1604933619,
  "ts_event": 1604933737,
  "ts": 1604937337,
}

Delivered

Attribute name

Data type

Description

event

string

"delivered"

email

string

recipient email

id

integer

internal id of webhook

date_sent

string

date the campaign was sent (year-month-day, hour:minute:second)

date_event

string

date the event occurred (year-month-day, hour:minute:second)

ts_sent

integer

timestamp in seconds of when campaign was sent

ts_event

integer

timestamp in seconds of when event occurred

sending_ip

string

ip used to send message

camp_id

integer

internal id of campaign

campaign name

string

internal name of campaign

ts

integer

timestamp in seconds of when event occurred

tag

string

internal tag of campaign

{
  "id": xxxxxx,
  "camp_id": xx,
  "email": "[email protected]",
  "campaign name": "My First Campaign",
  "date_sent": "2020-10-09 00:00:00",
  "date_event": "2020-10-09 00:00:00",
  "event": "delivered",
  "tag": "",
  "sending_ip": "xxx.xxx.xxx.xxx"
  "ts_sent": 1604933619,
  "ts_event": 1604933737,
  "ts": 1604937337,
}


Unsubscribed

Attribute name

Data type

Description

event

string

"unsubscribe"

email

string

recipient email

id

integer

internal id of webhook

date_sent

string

date the campaign was sent (year-month-day, hour:minute:second)

date_event

string

date the event occurred (year-month-day, hour:minute:second)

ts_sent

integer

timestamp in seconds of when campaign was sent

ts_event

integer

timestamp in seconds of when event occurred

camp_id

integer

internal id of campaign

campaign name

string

internal name of campaign

list_id

array of integers

the internal list id's the recipient has been unsubscribed from

ts

integer

timestamp in seconds of when event occurred

tag

string

internal tag of campaign

{
  "id": xxxxxx,
  "camp_id": xx,
  "email": "[email protected]",
  "campaign name": "My First Campaign",
  "date_sent": "2020-10-09 00:00:00",
  "date_event": "2020-10-09 00:00:00",
  "event": "unsubscribed",
  "tag": "",
  "sending_ip": "xxx.xxx.xxx.xxx",
   "list_id": [
    3,
    42,
  ],
  "ts_sent": 1604933619,
  "ts_event": 1604933737,
  "ts": 1604937337,
}

Contact deleted

Attribute name

Data type

Description

event

string

"contact_deleted"

email

string

email address of added recipient

id

integer

internal id of webhook

key

string

internal key

date

string

date the event occurred (year-month-day, hour:minute:second)

ts

integer

timestamp in seconds of when event occurred

{
  "id": xxxxxx,
  "email": "[email protected]",
  "event": "contact_deleted",
  "key": "xxxxxxxxxxxxxxxxxx",
  "list_id": [
    35
  ],
  "date": "2020-10-09 00:00:00",
  "ts": 1604937111
}

Contact updated

Attribute name

Data type

Description

event

string

"contact_updated"

email

string

email address of added recipient

id

integer

internal id of webhook

key

string

internal key

date

string

date the event occurred (year-month-day, hour:minute:second)

ts

integer

timestamp in seconds of when event occurred

content

array of strings

full contact information with updates

{
  "id": xxxxxx,
  "email": "[email protected]",
  "event": "contact_updated",
  "key": "xxxxxxxxxxxxxxxxxx",
  "content": [
    "name": "John",
    "lastname" : "Doe",
    "work_phone": "+506 2220 2307"
  ],
  "date": "2020-10-09 00:00:00",
  "ts": 1604937111
}

Contact added to list

Attribute name

Data type

Description

event

string

"list_addition"

email

string

email address of added recipient

id

integer

internal id of webhook

key

string

internal key

date

string

date the event occurred (year-month-day, hour:minute:second)

ts

integer

timestamp in seconds of when event occurred

list_id

array of integers

array of lists where the contact is now present.

{
  "id": xxxxxx,
  "email": "[email protected]",
  "event": "list_addition",
  "key": "xxxxxxxxxxxxxxxxxx",
  "list_id": [
         34,
     12
  ],
  "date": "2020-10-09 00:00:00",
  "ts": 1604937111
}

Did this page help you?