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
Attribute name Data type Description eventstring "spam" emailstring recipient email idinteger internal id of webhook date_sentstring date the campaign was sent (year-month-day, hour:minute:second) date_eventstring date the event occurred (year-month-day, hour:minute:second) ts_sentinteger timestamp in seconds of when campaign was sent ts_eventinteger timestamp in seconds of when event occurred camp_idinteger internal id of campaign campaign namestring internal name of campaign reasonstring spam reason tsinteger timestamp in seconds of when event occurred tagstring internal tag of campaign
JSON
{
"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,
}
Attribute name Data type Description eventstring "opened" emailstring recipient email idinteger internal id of webhook date_sentstring date the campaign was sent (year-month-day, hour:minute:second) date_eventstring date the event occurred (year-month-day, hour:minute:second) ts_sentinteger timestamp in seconds of when campaign was sent ts_eventinteger timestamp in seconds of when event occurred camp_idinteger internal id of campaign campaign namestring internal name of campaign tagstring internal tag of campaign tsinteger timestamp in seconds of when event occurred segment_idsarray of integers newly added fields for mails that are sent to a segment
JSON
{
"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": "",
"segment_ids": [
1,
10,
],
"ts_sent": 1604933619,
"ts_event": 1604933737,
"ts": 1604937337
}
Attribute name Data type Description eventstring "click" emailstring recipient email idinteger internal id of webhook date_sentstring date the campaign was sent (year-month-day, hour:minute:second) date_eventstring date the event occurred (year-month-day, hour:minute:second) ts_sentinteger timestamp in seconds of when campaign was sent ts_eventinteger timestamp in seconds of when event occurred camp_idinteger internal id of campaign campaign namestring internal name of campaign tagstring internal tag of campaign tsinteger timestamp in seconds of when event occurred URLstring url clicked segment_idsarray of integers newly added fields for mails that are sent to a segment
JSON
{
"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": "",
"segment_ids": [
1,
10,
],
"ts_sent": 1604933619,
"ts_event": 1604933737,
"ts": 1604937337,
"URL": "https://myCampaignUrl.net"
}
Attribute name Data type Description eventstring "hard_bounce" emailstring recipient email idinteger internal id of webhook date_sentstring date the campaign was sent (year-month-day, hour:minute:second) date_eventstring date the event occurred (year-month-day, hour:minute:second) ts_sentinteger timestamp in seconds of when campaign was sent ts_eventinteger timestamp in seconds of when event occurred camp_idinteger internal id of campaign campaign namestring internal name of campaign sending_ipstring ip used to send message reasonstring hard bounce reason tsinteger timestamp in seconds of when event occurred tagstring internal tag of campaign
JSON
{
"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_bounce",
"tag": "",
"sending_ip": "xxx.xxx.xxx.xxx",
"ts_sent": 1604933619,
"ts_event": 1604933737,
"ts": 1604937337,
}
Attribute type Data type Description eventstring "soft_bounce" emailstring recipient email id1integer internal id of webhook date_sentstring date the campaign was sent (year-month-day, hour:minute:second) date_eventstring date the event occurred (year-month-day, hour:minute:second) ts_sentinteger timestamp in seconds of when campaign was sent ts_eventinteger timestamp in seconds of when event occurred camp_idinteger internal id of campaign campaign namestring internal name of campaign reasonstring soft bounce reason sending_ipstring ip used to send message tsinteger timestamp in seconds of when event occurred tagstring internal tag of campaign
JSON
{
"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,
}
Attribute name Data type Description eventstring "delivered" emailstring recipient email idinteger internal id of webhook date_sentstring date the campaign was sent (year-month-day, hour:minute:second) date_eventstring date the event occurred (year-month-day, hour:minute:second) ts_sentinteger timestamp in seconds of when campaign was sent ts_eventinteger timestamp in seconds of when event occurred sending_ipstring ip used to send message camp_idinteger internal id of campaign campaign namestring internal name of campaign tsinteger timestamp in seconds of when event occurred tagstring internal tag of campaign
JSON
{
"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,
}
Attribute name Data type Description eventstring "unsubscribe" emailstring recipient email idinteger internal id of webhook date_sentstring date the campaign was sent (year-month-day, hour:minute:second) date_eventstring date the event occurred (year-month-day, hour:minute:second) ts_sentinteger timestamp in seconds of when campaign was sent ts_eventinteger timestamp in seconds of when event occurred camp_idinteger internal id of campaign campaign namestring internal name of campaign list_idarray of integers the internal list id's the recipient has been unsubscribed from tsinteger timestamp in seconds of when event occurred tagstring internal tag of campaign segment_idsarray of integers newly added fields for mails that are sent to a segment
JSON
{
"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": "unsubscribe",
"tag": "",
"sending_ip": "xxx.xxx.xxx.xxx",
"list_id": [
3,
42,
],
"segment_ids": [
1,
10,
],
"ts_sent": 1604933619,
"ts_event": 1604933737,
"ts": 1604937337,
}
Attribute name Data type Description eventstring "contact_deleted" emailstring email address of added recipient idinteger internal id of webhook keystring internal key datestring date the event occurred (year-month-day, hour:minute:second) tsinteger timestamp in seconds of when event occurred
JSON
{
"id": xxxxxx,
"email": "[email protected] ",
"event": "contact_deleted",
"key": "xxxxxxxxxxxxxxxxxx",
"list_id": [
35
],
"date": "2020-10-09 00:00:00",
"ts": 1604937111
}
Attribute name Data type Description eventstring "contact_updated" emailstring email address of added recipient idinteger internal id of webhook keystring internal key datestring date the event occurred (year-month-day, hour:minute:second) tsinteger timestamp in seconds of when event occurred contentarray of strings full contact information with updates
JSON
{
"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
}
Attribute name Data type Description eventstring "list_addition" emailstring email address of added recipient idinteger internal id of webhook keystring internal key datestring date the event occurred (year-month-day, hour:minute:second) tsinteger timestamp in seconds of when event occurred list_idarray of integers array 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.
JSON
{
"id": xxxxxx,
"email": "[email protected] ",
"event": "list_addition",
"key": "xxxxxxxxxxxxxxxxxx",
"list_id": [
34,
12
],
"date": "2020-10-09 00:00:00",
"ts": 1604937111
}
Attribute name Data type Description idinteger unique id generated for each payload tostring mobile number sms_countinteger number of sms parts sent credits_usedfloat credits deducted remaining_creditfloat remaining balance credit msg_statusstring status of the message(sent, delivered, soft_bounce, hard_bounce) datestring time at which the event is generated typestring type of sms(marketing/transactional) campaign_idinteger campaign id for campaign sms
JSON
{
"id": 26570,
"to": "918076721713",
"sms_count": 1,
"credits_used": 1.5,
"remaining_credit": 11488.845,
"msg_status": "sent",
"date": "2024-10-11 14:19:59",
"type": "marketing",
"campaign_id": 220
}
Attribute name Data type Description idinteger unique id generated for each payload tostring mobile number msg_statusstring status of the message(sent, delivered, soft_bounce, hard_bounce) datestring time at which the event is generated typestring type of sms(marketing/transactional) campaign_idinteger campaign id for campaign sms statusstring status descriptionstring Bounce Reason for Failed to deliver message ts_eventinteger timestamp in seconds of when event occurred tagarray of strings internal tag of campaign
JSON
{
"id": 26527,
"status": "OK",
"msg_status": "delivered",
"description": "delivered",
"to": "919102606271",
"ts_event": 1728459617,
"date": "2024-10-09 13:10:17",
"tag": [
"tag1name"
],
"type": "marketing",
"campaign_id": 220
}
Attribute name Data type Description idinteger unique id generated for each payload tostring mobile number msg_statusstring status of the message(sent, delivered, soft_bounce, hard_bounce etc.) datestring time at which the event is generated typestring type of sms(marketing/transactional) campaign_idinteger campaign id for campaign sms descriptionstring Bounce Reason for Failed to deliver message, description of the event ts_eventinteger timestamp in seconds of when event occurred tagarray of strings internal tag of campaign error_codeinteger error code replystring reply of the sms
JSON
{
"id": 26519,
"msg_status": "replied",
"error_code": 101,
"description": "replied",
"to": "919368207022",
"reply": "Hi",
"ts_event": 1728386415,
"date": "2024-10-08 16:50:16",
"tag": [
"tag1name","tag2name"
],
"type": "marketing",
"campaign_id": 220
}
Attribute name Data type Description idinteger unique id generated for each payload tostring mobile number msg_statusstring status of the message(sent, delivered, soft_bounce, hard_bounce etc.) datestring time at which the event is generated typestring type of sms(marketing/transactional) campaign_idinteger campaign id for campaign sms descriptionstring Bounce Reason for Failed to deliver message, description of the event ts_eventinteger timestamp in seconds of when event occurred tagarray of strings internal tag of campaign error_codeinteger error code bounce_typestring hard bounce or soft bounce
JSON
{
"id": 26519,
"msg_status": "soft_bounce",
"description": "Failed to deliver message for reasons unknown",
"bounce_type": "soft_bounce",
"error_code": 7,
"to": "916778678623",
"ts_event": 1728390422,
"date": "2024-10-08 17:57:03",
"tag": [
"tag1name","tag2name"
],
"type": "marketing",
"campaign_id": 220
}
Attribute name Data type Description idinteger unique id generated for each payload tostring mobile number msg_statusstring status of the message(sent, delivered, soft_bounce, hard_bounce etc.) datestring time at which the event is generated typestring type of sms(marketing/transactional) campaign_idinteger campaign id for campaign sms descriptionstring Bounce Reason for Failed to deliver message, description of the event ts_eventinteger timestamp in seconds of when event occurred tagarray of strings internal tag of campaign error_codeinteger error code bounce_typestring hard bounce or soft bounce
JSON
{
"id": 26519,
"msg_status": "hard_bounce",
"description": "Message is undeliverable due to an incorrect / invalid / blacklisted / permanently barred MSISDN for this operator",
"bounce_type": "hard_bounce",
"error_code": 23,
"to": "916778678623",
"ts_event": 1728390422,
"date": "2024-10-08 17:57:03",
"tag": [
"tag1name","tag2name"
],
"type": "marketing"
"campaign_id": 220
}
Attribute name Data type Description idinteger unique id generated for each payload tostring mobile number msg_statusstring status of the message(sent, delivered, soft_bounce, hard_bounce etc.) datestring time at which the event is generated typestring type of sms(marketing/transactional) campaign_idinteger campaign id for campaign sms descriptionstring Bounce Reason for Failed to deliver message, description of the event ts_eventinteger timestamp in seconds of when event occurred tagarray of strings internal tag of campaign error_codeinteger error code replystring reply of the sms
JSON
{
"id": 26527,
"msg_status": "subscribe",
"description": "subscribe",
"to": "919102606271",
"reply": "START",
"ts_event": 1728459617,
"error_code": 101,
"date": "2024-10-09 13:10:17",
"tag": [
"tag1name"
],
"type": "marketing",
"campaign_id": 220
}
Attribute name Data type Description idinteger unique id generated for each payload tostring mobile number msg_statusstring status of the message(sent, delivered, soft_bounce, hard_bounce etc.) datestring time at which the event is generated typestring type of sms(marketing/transactional) campaign_idinteger campaign id for campaign sms descriptionstring Bounce Reason for Failed to deliver message, description of the event ts_eventinteger timestamp in seconds of when event occurred tagarray of strings internal tag of campaign error_codeinteger error code replystring reply of the sms
JSON
{
"id": 26527,
"msg_status": "unsubscribed",
"description": "unsubscribed",
"to": "919102606271",
"ts_event": 1728459617,
"error_code": 100,
"reply": "STOP",
"date": "2024-10-09 13:10:17",
"tag": [
"tag1name"
],
"type": "marketing",
"campaign_id": 220
}
Attribute name Data type Description idinteger unique id generated for each payload tostring mobile number msg_statusstring status of the message(sent, delivered, soft_bounce, hard_bounce etc.) datestring time at which the event is generated typestring type of sms(marketing/transactional) campaign_idinteger campaign id for campaign sms descriptionstring Bounce Reason for Failed to deliver message, description of the event ts_eventinteger timestamp in seconds of when event occurred tagarray of strings internal tag of campaign messageIdinteger message id for transactional sms
JSON
{
"id": 26519,
"msg_status": "skip",
"description": "skip",
"to": "12018577757",
"ts_event": 1728390414,
"date": "2024-10-08 17:56:54",
"messageId": 0,
"tag": [
"tag1name","tag2name"
],
"type": "marketing",
"campaign_id": 220
}
