{
"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"
}SendX Webhook Object
SendX webhooks allow you to receive real-time notifications about various events in your team. Every event generated as a SendX webhook will include a type field in the event object that identifies the type of event that occurred.
{
"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"
}| Webhook Event | Type Field Value |
|---|---|
| Contact Events | |
| ContactCreated | 74 |
| GlobalUnsubscribe | 73 |
| Mail Opened Events | |
| MailOpen (Campaign) | 7 |
| DripStepMailOpen | 32 |
| RssExecMailOpen | 172 |
| WorkflowEmailMailOpen | 189 |
| SeedContactMailOpen | 271 |
| Link Clicked Events | |
| LinkClick (Campaign) | 8 |
| DripStepLinkClick | 33 |
| RssExecLinkClick | 173 |
| WorkflowEmailLinkClick | 190 |
| SeedContactLinkClick | 272 |
| Mail Bounced Events | |
| MailBounced (Campaign) | 5 |
| DripStepMailBounced | 63 |
| RssExecMailBounced | 180 |
| WorkflowEmailMailBounced | 197 |
| SeedContactMailBounced | 276 |
| Mail Spam Events | |
| MailSpam (Campaign) | 6 |
| DripStepMailSpam | 62 |
| RssExecMailSpam | 179 |
| WorkflowEmailMailSpam | 196 |
| SeedContactMailSpam | 275 |
| Mail Dropped Events | |
| MailDropped (Campaign) | 60 |
| DripStepMailDropped | 61 |
| RssExecMailDropped | 178 |
| WorkflowEmailMailDropped | 195 |
| SeedContactMailDropped | 278 |
Authorizations
Team API key for authentication. Find your API key in SendX Settings → Team API Key.
Example:
X-Team-ApiKey: your_team_api_key_here
Body
The type of the event.
7
The timestamp of the event in milliseconds since the epoch.
1686304219037565000
Arbitrary data associated with the event.
"{\"key\": \"value\"}"
Optional provider message ID.
"provider_message_id_123"
Optional campaign ID.
"campaign_id_123"
Optional drip step ID.
"drip_step_id_123"
Optional RSS execution ID.
"rss_exec_id_123"
Optional tag ID.
"tag_id_123"
Optional link associated with the event.
"https://example.com"
Optional list ID.
"list_id_123"
Optional contact ID.
"contact_id_123"
Optional contact email.
"contact@example.com"
Optional custom field ID.
"custom_field_id_123"
Optional template ID.
"template_id_123"
Optional popup ID.
"popup_id_123"
Optional landing page ID.
"landing_page_id_123"
Optional form ID.
"form_id_123"
Optional segment ID.
"segment_id_123"
Optional automation ID.
"automation_id_123"
Optional drip ID.
"drip_id_123"
Optional RSS ID.
"rss_id_123"
Optional A/B test ID.
"ab_test_id_123"
Optional workflow ID.
"workflow_id_123"
Optional workflow node ID.
"workflow_node_id_123"
Optional workflow email ID.
"workflow_email_id_123"
Response
Return a 200 status to indicate that the data was received successfully
Was this page helpful?