System Webhooks

You can send data from email or push events to a third party system by setting up a system webhook in Iterable. To do this, go to Integrations--> Webhooks on the left menu. 

Enter in the webhook URL and click 'Create Webhook'.

 

 

Click the 'Edit' button, check the 'Enabled' box and select the events you'd like to send data for to the webhook.

 

The available options for Webhook events you wish to keep track of are:

 

These simple webhooks will send a POST request with two headers to your specified endpoint. The headers are: `Content-Type`, value = `application/json`, and an Authorization header.

If your authorization token is XXX, then Basic will send `Authorization: XXX`, and OAuth2 will send `Authorization: Bearer XXX`

So for example if you select OAuth, and `J1qK1c18UUGJFAzz9xnH56584l4 ` is your token, then the header will be `Authorization: OAuth J1qK1c18UUGJFAzz9xnH56584l4` The body of the request will contain the following fields: `email`, `eventName`, and any other data that was in the triggering event inside a field called `dataFields`.

Here are the sample responses for each type of event.

 

 

Triggered Send 

{
   "email": "jeremy+test@iterable.com",
   "eventName": "emailSend",
   "dataFields": {
      "contentId": 274222,
      "email": "jeremy+test@iterable.com",
      "createdAt": "2016-12-02 18:51:40 +00:00",
      "campaignId": 49313,
      "templateId": 79190,
      "messageId": "210badf49fe54f2591d64ad0d055f4fb",
      "emailSubject": "My Subject",
      "campaignName": "Testing attribution",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Attribution to any in time range test",
      "channelId": 3420,
      "messageTypeId": 3866,
      "experimentId": null,
      "emailId": "c49313:t79190:jeremy+test@iterable.com"
   }
}

 

Blast Send

{
   "email": "jeremy+test@iterable.com",
   "eventName": "emailSend",
   "dataFields": {
      "contentId": 331201,
      "email": "jeremy+test@iterable.com",
      "createdAt": "2016-12-02 20:21:04 +00:00",
      "campaignId": 59667,
      "templateId": 93849,
      "messageId": "d3c44d47b4994306b4db8d16a94db025",
      "emailSubject": "Welcome to JM Photography at {{now}}",
      "campaignName": "Test the NOW handlebars",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Sample photography welcome",
      "channelId": 3420,
      "messageTypeId": 3866,
      "experimentId": null,
      "emailId": "c59667:t93849:jeremy+test@iterable.com"
   }
}

 

Push Send

{
   "email": "sherry@iterable.com",
   "eventName": "pushSend",
   "dataFields": {
      "contentId": 6724,
      "platformEndpoint": "<your_platform_endpoint_data>",
      "email": "sherry@iterable.com",
      "createdAt": "2016-12-08 00:53:11 +00:00",
      "campaignId": 74758,
      "templateId": 113541,
      "messageId": "73f2d3f13cd04db0b56c6143b179adc5",
      "pushMessage": "Hi {{firstName}}, here is a push! 😀",
      "campaignName": "test webhook",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Sherry Test Push",
      "channelId": 1744,
      "messageTypeId": 1759,
      "experimentId": null,
      "payload": {
         "a": "2"
      },
      "sound": "",
      "badge": "",
      "contentAvailable": false,
      "deeplink": null,
      "locale": null
   }
}

 

Push Open

{
   "email":"jeremy+testpush@iterable.com",
   "eventName": "pushOpen",
   "dataFields": {
      "appAlreadyRunning": false,
      "email": "jeremy+testpush@iterable.com",
      "createdAt": "2016-12-08 01:25:22 +00:00",
      "campaignId": 74768,
      "templateId": 113554,
      "pushMessage": "Use promo to get 20% off your next order",
      "campaignName": "Test push",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Pay Push - Audience",
      "channelId": 2203,
      "messageTypeId": 2439,
      "experimentId": null,
      "payload": {
         "path": "shop_home"
      },
      "sound": null,
      "badge": null,
      "contentAvailable": false,
      "deeplink": null,
      "locale": null
   }
}

 

Push Bounce

{
   "email": "jeremy+testpush@iterable.com",
   "eventName": "pushBounce",
   "dataFields": {
      "platformEndpoint": "yourEndpoint",
      "email": "jeremy+testpush@iterable.com",
      "createdAt": "2016-12-10 01:00:38 +00:00",
      "campaignId": 74768,
      "templateId": 113554,
      "pushMessage": "Here's a push message",
      "campaignName": "Test Push webhooks",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Test push template",
      "channelId": 2203,
      "messageTypeId": 2439,
      "experimentId": null,
      "payload": {
         "path": "yourpath/subpath"
      },
      "sound": "",
      "badge": null,
      "contentAvailable": false,
      "deeplink": null,
      "locale": null
   }
}

 

Push Uninstall

{
   "email": "jeremy+testpush@iterable.com",
   "eventName": "pushUninstall",
   "dataFields": {
      "isGhostPush": false,
      "platformEndpoint": "yourEndpoint",
      "email": "jeremy+testpush@iterable.com",
      "createdAt": "2016-12-09 20:50:54 +00:00",
      "campaignId":74768,
      "templateId": 113554,
      "messageId": "73f2d3f13cd04db0b56c6143b179adc5",
      "pushMessage": "Here's a push message",
      "campaignName": "Push test webhook",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Test push template",
      "channelId": 2203,
      "messageTypeId": 2439,
      "experimentId": null,
      "payload": {
         "path": "your_folder/30"
      },
      "sound": "",
      "badge": null,
      "contentAvailable": false,
      "deeplink": null,
      "locale": null
   }
}

 

 SMS Send

{
   "email": "jeremy+testsms@iterable.com",
   "eventName": "smsSend",
   "dataFields": {
      "toPhoneNumber": "+16502857641",
      "fromSMSSenderId": 258,
      "contentId": 2086,
      "email": "jeremy+testsms@iterable.com",
      "createdAt": "2016-12-05 21:50:32 +00:00",
      "campaignId": 73974,
      "templateId": 112523,
      "smsMessage": "Here is example message",
      "campaignName": "Test SMS for webhook",
      "workflowId": null,
      "workflowName": null,
      "templateName": "SMS testing",
      "channelId": 4270,
      "messageTypeId": 4769,
      "experimentId": null,
      "fromPhoneNumberId": 258,
      "imageUrl": null,
      "locale": null,
      "emailId": "c73974:t112523:jeremy+testsms@iterable.com"
   }
}

 

SMS Bounce

{
   "email": "jeremy+testsms@iterable.com",
   "eventName": "smsBounce",
   "dataFields": {
      "smsProviderResponse": {
         "status": 404,
         "message": "The requested resource /2010-04-01/Accounts/ACCOUNT_NUMBER/Messages.json was not found",
         "code": 20404,
         "more_info": "https://www.twilio.com/docs/errors/20404"
      },
      "email": "jeremy+testsms@iterable.com",
      "createdAt": "2016-12-05 22:43:24 +00:00",
      "campaignId": 74003,
      "templateId": 112561,
      "smsMessage": "Here is example message, please respond with 'received'",
      "campaignName": "Test SMS for webhook",
      "workflowId": null,
      "workflowName": null,
      "templateName": "SMS testing",
      "channelId": 4270,
      "messageTypeId": 4769,
      "experimentId": null,
      "fromPhoneNumberId": 268,
      "imageUrl": null,
      "locale": null,
      "emailId": "c74003:t112561:jeremy+testsms@iterable.com"
   }
}

 

SMS Received

{
   "email": "jeremy+testsms@iterable.com",
   "eventName": "smsReceived",
   "dataFields": {
      "fromPhoneNumber": "+16502857641",
      "toPhoneNumber": "+14155824541",
      "smsMessage": "I responded to the text",
      "email": "jeremy+testsms@iterable.com",
      "createdAt": "2016-12-05 22:51:25 +00:00"
   }
}

 

Email Open

{
   "email": "jeremy+test@iterable.com",
   "eventName": "emailOpen",
   "dataFields": {
      "userAgent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
      "ip": "66.249.84.204",
      "templateId": 79190,
      "device": "Gmail",
      "email": "jeremy+test@iterable.com",
      "createdAt": "2016-12-02 18:51:45 +00:00",
      "campaignId": 49313,
      "messageId": "210badf49fe54f2591d64ad0d055f4fb",
      "emailSubject": "My Subject",
      "campaignName": "Testing attribution",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Attribution to any in time range test",
      "channelId": 3420,
      "messageTypeId": 3866,
      "experimentId": null,
      "emailId": "c49313:t79190:jeremy+test@iterable.com"
   }
}

 

Email Click

{
   "email": "jeremy+test@iterable.com",
   "eventName": "emailClick",
   "dataFields": {
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36",
      "ip": "162.245.22.184",
      "templateId": 93849,
      "device": "Mac",
      "url": "https://www.linkedin.com/in/jeremy-moffett-9a9635102",
      "canonicalUrlId": "3145668988",
      "city": "San Francisco",
      "region": "CA",
      "email": "jeremy+test@iterable.com",
      "createdAt": "2016-12-02 20:31:39 +00:00",
      "campaignId": 59667,
      "messageId": "d3c44d47b4994306b4db8d16a94db025",
      "emailSubject": "Welcome to JM Photography at {{now}}",
      "campaignName": "Test the NOW handlebars",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Sample photography welcome",
      "channelId": 3420,
      "messageTypeId": 3866,
      "experimentId": null,
      "linkUrl": "https://www.linkedin.com/in/jeremy-moffett-9a9635102",
      "linkId": "3145668988",
      "emailId": "c59667:t93849:jeremy+test@iterable.com"
   }
}

 

Email Complaint

{
   "email": "jeremy+complaint@iterable.com",
   "eventName": "emailComplaint",
   "dataFields": {
      "recipientState": "Complaint",
      "templateId":79190,
      "email": "jeremy+complaint@iterable.com",
      "createdAt": "2016-12-09 18:52:19 +00:00",
      "campaignId":49313,
      "messageId": "d3c44d47b4994306b4db8d16a94db025",
      "emailSubject": "Subject line content",
      "campaignName": "My campaign name",
      "workflowId": null,
      "workflowName": null,
      "templateName": "test template",
      "channelId":3420,
      "messageTypeId":3866,
      "experimentId": null,
      "emailId": "c49313:t79190:jeremy+complaint@iterable.com"
   }
}

 

Email Bounce

{
   "email": "jeremy+OOO@iterable.com",
   "eventName": "emailBounce",
      "dataFields": {
      "recipientState": "SoftBounceUndetermined",
      "templateId": 79190,
      "email":"jeremy+OOO@iterable.com",
      "createdAt": "2016-12-02 22:21:03 +00:00",
      "campaignId": 49313,
      "emailSubject": "My Subject",
      "campaignName": "Testing attribution",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Attribution to any in time range test",
      "channelId": 3420,
      "messageTypeId": 3866,
      "experimentId": null,
      "emailId": "c49313:t79190:jeremy+OOO@iterable.com",
   }
}

 

Email Subscribe

{
   "email": "jeremy+test@iterable.com",
   "eventName": "emailSubscribe",
      "dataFields": {
      "channelId": 3420,
      "signupSource": "ResubscribePage",
      "email": "jeremy+test@iterable.com",
      "createdAt": "2016-12-02 22:15:02 +00:00"
   }

 

Email Unsubscribe

{
   "email": "jeremy+test@iterable.com",
   "eventName": "emailUnSubscribe",
   "dataFields": {
      "unsubSource": "EmailLink",
      "email": "jeremy+test@iterable.com",
      "createdAt": "2016-12-02 22:13:05 +00:00",
      "campaignId": 59667,
      "templateId": 93849,
      "messageId": "d3c44d47b4994306b4db8d16a94db025",
      "emailSubject": "Welcome to JM Photography at {{now}}",
      "campaignName": "Test the NOW handlebars",
      "workflowId": null,
      "workflowName": null,
      "templateName": "Sample photography welcome",
      "channelId": 3420,
      "messageTypeId": 3866,
      "experimentId": null,
      "emailId": "c59667:t93849:jeremy+test@iterable.com"
   }
}

 

 

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk