Skip to main content
WEBHOOK
SendXWebhooks
{
  "type": 7,
  "time": 1686304219037565000,
  "data": "{\"key\": \"value\"}",
  "provider_message_id": "provider_message_id_123",
  "campaign_id": "campaign_id_123",
  "drip_step_id": "drip_step_id_123",
  "rss_exec_id": "rss_exec_id_123",
  "tag_id": "tag_id_123",
  "link": "https://example.com",
  "list_id": "list_id_123",
  "contact_id": "contact_id_123",
  "contact_email": "contact@example.com",
  "custom_field_id": "custom_field_id_123",
  "template_id": "template_id_123",
  "popup_id": "popup_id_123",
  "landing_page_id": "landing_page_id_123",
  "form_id": "form_id_123",
  "segment_id": "segment_id_123",
  "automation_id": "automation_id_123",
  "drip_id": "drip_id_123",
  "rss_id": "rss_id_123",
  "ab_test_id": "ab_test_id_123",
  "workflow_id": "workflow_id_123",
  "workflow_node_id": "workflow_node_id_123",
  "workflow_email_id": "workflow_email_id_123"
}
Every event generated as SendX webhook will have type field in event object:
Webhook Event**Type **
Unsubscribed73
Marked Spam6
Mail Opened7
Link Clicked8
Mail Bounced58
Mail Dropped60

Body

application/json
​
type
integer

The type of the event.

Example:

7

​
time
integer

The timestamp of the event in milliseconds since the epoch.

Example:

1686304219037565000

​
data
string

Arbitrary data associated with the event.

Example:

"{\"key\": \"value\"}"

​
provider_message_id
string | null

Optional provider message ID.

Example:

"provider_message_id_123"

​
campaign_id
string | null

Optional campaign ID.

Example:

"campaign_id_123"

​
drip_step_id
string | null

Optional drip step ID.

Example:

"drip_step_id_123"

​
rss_exec_id
string | null

Optional RSS execution ID.

Example:

"rss_exec_id_123"

​
tag_id
string | null

Optional tag ID.

Example:

"tag_id_123"

​
link
string | null

Optional link associated with the event.

Example:

"https://example.com"

​
list_id
string | null

Optional list ID.

Example:

"list_id_123"

​
contact_id
string | null

Optional contact ID.

Example:

"contact_id_123"

​
contact_email
string | null

Optional contact email.

Example:

"contact@example.com"

​
custom_field_id
string | null

Optional custom field ID.

Example:

"custom_field_id_123"

​
template_id
string | null

Optional template ID.

Example:

"template_id_123"

​
popup_id
string | null

Optional popup ID.

Example:

"popup_id_123"

​
landing_page_id
string | null

Optional landing page ID.

Example:

"landing_page_id_123"

​
form_id
string | null

Optional form ID.

Example:

"form_id_123"

​
segment_id
string | null

Optional segment ID.

Example:

"segment_id_123"

​
automation_id
string | null

Optional automation ID.

Example:

"automation_id_123"

​
drip_id
string | null

Optional drip ID.

Example:

"drip_id_123"

​
rss_id
string | null

Optional RSS ID.

Example:

"rss_id_123"

​
ab_test_id
string | null

Optional A/B test ID.

Example:

"ab_test_id_123"

​
workflow_id
string | null

Optional workflow ID.

Example:

"workflow_id_123"

​
workflow_node_id
string | null

Optional workflow node ID.

Example:

"workflow_node_id_123"

​
workflow_email_id
string | null

Optional workflow email ID.

Example:

"workflow_email_id_123"

Response

200

Return a 200 status to indicate that the data was received successfully

⌘I