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 to 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 nameData typeDescription
eventstring"spam"
emailstringrecipient email
idintegerinternal id of webhook
date_sentstringdate the campaign was sent (year-month-day, hour:minute:second)
date_eventstringdate the event occurred (year-month-day, hour:minute:second)
ts_sentintegertimestamp in seconds of when campaign was sent
ts_eventintegertimestamp in seconds of when event occurred
camp_idintegerinternal id of campaign
campaign_namestringinternal name of campaign
reasonstringspam reason
tsintegertimestamp in seconds of when event occurred
tagstringinternal 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 nameData typeDescription
eventstring"opened"
emailstringrecipient email
idintegerinternal id of webhook
date_sentstringdate the campaign was sent (year-month-day, hour:minute:second)
date_eventstringdate the event occurred (year-month-day, hour:minute:second)
ts_sentintegertimestamp in seconds of when campaign was sent
ts_eventintegertimestamp in seconds of when event occurred
camp_idintegerinternal id of campaign
campaign namestringinternal name of campaign
tagstringinternal tag of campaign
tsintegertimestamp 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 nameData typeDescription
eventstring"click"
emailstringrecipient email
idintegerinternal id of webhook
date_sentstringdate the campaign was sent (year-month-day, hour:minute:second)
date_eventstringdate the event occurred (year-month-day, hour:minute:second)
ts_sentintegertimestamp in seconds of when campaign was sent
ts_eventintegertimestamp in seconds of when event occurred
camp_idintegerinternal id of campaign
campaign namestringinternal name of campaign
tagstringinternal tag of campaign
tsintegertimestamp in seconds of when event occurred
URLstringurl 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 nameData typeDescription
eventstring"hard_bounce"
emailstringrecipient email
idintegerinternal id of webhook
date_sentstringdate the campaign was sent (year-month-day, hour:minute:second)
date_eventstringdate the event occurred (year-month-day, hour:minute:second)
ts_sentintegertimestamp in seconds of when campaign was sent
ts_eventintegertimestamp in seconds of when event occurred
camp_idintegerinternal id of campaign
campaign namestringinternal name of campaign
sending_ipstringip used to send message
reasonstringhardbounce reason
tsintegertimestamp in seconds of when event occurred
tagstringinternal 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 typeData typeDescription
eventstring"soft_bounce"
emailstringrecipient email
id1integerinternal id of webhook
date_sentstringdate the campaign was sent (year-month-day, hour:minute:second)
date_eventstringdate the event occurred (year-month-day, hour:minute:second)
ts_sentintegertimestamp in seconds of when campaign was sent
ts_eventintegertimestamp in seconds of when event occurred
camp_idintegerinternal id of campaign
campaign namestringinternal name of campaign
reasonstringsoftbounce reason
sending_ipstringip used to send message
tsintegertimestamp in seconds of when event occurred
tagstringinternal 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 nameData typeDescription
eventstring"delivered"
emailstringrecipient email
idintegerinternal id of webhook
date_sentstringdate the campaign was sent (year-month-day, hour:minute:second)
date_eventstringdate the event occurred (year-month-day, hour:minute:second)
ts_sentintegertimestamp in seconds of when campaign was sent
ts_eventintegertimestamp in seconds of when event occurred
sending_ipstringip used to send message
camp_idintegerinternal id of campaign
campaign namestringinternal name of campaign
tsintegertimestamp in seconds of when event occurred
tagstringinternal 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,
}


Unsubscribe

Attribute nameData typeDescription
eventstring"unsubscribe"
emailstringrecipient email
idintegerinternal id of webhook
date_sentstringdate the campaign was sent (year-month-day, hour:minute:second)
date_eventstringdate the event occurred (year-month-day, hour:minute:second)
ts_sentintegertimestamp in seconds of when campaign was sent
ts_eventintegertimestamp in seconds of when event occurred
camp_idintegerinternal id of campaign
campaign namestringinternal name of campaign
list_idarray of integersthe internal list id's the recipient has been unsubscribed from
tsintegertimestamp in seconds of when event occurred
tagstringinternal 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 nameData typeDescription
eventstring"contact_deleted"
emailstringemail address of added recipient
idintegerinternal id of webhook
keystringinternal key
datestringdate the event occurred (year-month-day, hour:minute:second)
tsintegertimestamp 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 nameData typeDescription
eventstring"contact_updated"
emailstringemail address of added recipient
idintegerinternal id of webhook
keystringinternal key
datestringdate the event occurred (year-month-day, hour:minute:second)
tsintegertimestamp in seconds of when event occurred
contentarray of stringsfull 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 nameData typeDescription
eventstring"list_addition"
emailstringemail address of added recipient
idintegerinternal id of webhook
keystringinternal key
datestringdate the event occurred (year-month-day, hour:minute:second)
tsintegertimestamp in seconds of when event occurred
list_idarray of integersarray of lists where the contact is now present.

There is a possibility to transfer multiple emails as adding contacts to the list. Also, this webhook is triggered when a list of multiple contacts is added through the API endpoint.

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