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

Marketing email

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
`segment_ids`	array of integers	newly added fields for mails that are sent to a segment

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

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
`segment_ids`	array of integers	newly added fields for mails that are sent to a segment

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

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	hard bounce 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_bounce",
  "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	soft bounce 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,
}

Unsubscribe

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
`segment_ids`	array of integers	newly added fields for mails that are sent to a segment

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

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.

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
}

Marketing SMS

Sent

Attribute name	Data type	Description
`id`	integer	unique id generated for each payload
`to`	string	mobile number
`sms_count`	integer	number of sms parts sent
`credits_used`	float	credits deducted
`remaining_credit`	float	remaining balance credit
`msg_status`	string	status of the message(sent, delivered, soft_bounce, hard_bounce)
`date`	string	time at which the event is generated
`type`	string	type of sms(marketing/transactional)
`campaign_id`	integer	campaign id for campaign sms

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

Delivered

Attribute name	Data type	Description
`id`	integer	unique id generated for each payload
`to`	string	mobile number
`msg_status`	string	status of the message(sent, delivered, soft_bounce, hard_bounce)
`date`	string	time at which the event is generated
`type`	string	type of sms(marketing/transactional)
`campaign_id`	integer	campaign id for campaign sms
`status`	string	status
`description`	string	Bounce Reason for Failed to deliver message
`ts_event`	integer	timestamp in seconds of when event occurred
`tag`	array of strings	internal tag of campaign

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

Replied

Attribute name	Data type	Description
`id`	integer	unique id generated for each payload
`to`	string	mobile number
`msg_status`	string	status of the message(sent, delivered, soft_bounce, hard_bounce etc.)
`date`	string	time at which the event is generated
`type`	string	type of sms(marketing/transactional)
`campaign_id`	integer	campaign id for campaign sms
`description`	string	Bounce Reason for Failed to deliver message, description of the event
`ts_event`	integer	timestamp in seconds of when event occurred
`tag`	array of strings	internal tag of campaign
`error_code`	integer	error code
`reply`	string	reply of the sms

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

Soft bounce

Attribute name	Data type	Description
`id`	integer	unique id generated for each payload
`to`	string	mobile number
`msg_status`	string	status of the message(sent, delivered, soft_bounce, hard_bounce etc.)
`date`	string	time at which the event is generated
`type`	string	type of sms(marketing/transactional)
`campaign_id`	integer	campaign id for campaign sms
`description`	string	Bounce Reason for Failed to deliver message, description of the event
`ts_event`	integer	timestamp in seconds of when event occurred
`tag`	array of strings	internal tag of campaign
`error_code`	integer	error code
`bounce_type`	string	hard bounce or soft bounce

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

Skip

Attribute name	Data type	Description
`id`	integer	unique id generated for each payload
`to`	string	mobile number
`msg_status`	string	status of the message(sent, delivered, soft_bounce, hard_bounce etc.)
`date`	string	time at which the event is generated
`type`	string	type of sms(marketing/transactional)
`campaign_id`	integer	campaign id for campaign sms
`description`	string	Bounce Reason for Failed to deliver message, description of the event
`ts_event`	integer	timestamp in seconds of when event occurred
`tag`	array of strings	internal tag of campaign
`messageId`	integer	message id for transactional sms

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

Marketing webhooks

📘
Datetime parameters 🕗

Marketing email

Marked as Spam

Opened

Clicked

Hard Bounced

Soft Bounced

Delivered

Unsubscribe

Contact deleted

Contact updated

Contact added to list

Marketing SMS

Sent

Delivered

Replied

Soft bounce

Skip

📘Datetime parameters 🕗

Marketing email

Marked as Spam

Opened

Clicked

Hard Bounced

Soft Bounced

Delivered

Unsubscribe

Contact deleted

Contact updated

Contact added to list

Marketing SMS

Sent

Delivered

Replied

Soft bounce

Skip

📘
Datetime parameters 🕗