Posting Back Deliveries and Clicks for Campaigns

If you have an API based campaign you can post back Delivery and click-through info to your own or a collaborator's endpoints for tracking purposes if necessary. This will work for both the Template and Trigger, and Create and Send via API pattern. 

Please Note: Delivery notifications will not function as expected for Android Push, iOS Push or Safari Web-Push campaigns. It is not recommended to rely on the post-backs for these types of messages due to the nature of the channel. Deliveries can be tracked as expected for Chrome and Firefox Web-Push, however.

For the template and trigger pattern, the postback URLs can be set when executing the campaign using the following params

use these params in your execute/campaign API call as shown below:

URL: https://external-api.xtremepush.com/api/external/execute/campaign
POST DATA: 
{
    "apptoken": "APPTOKEN",
    ....,
    "webhook_delivery": "https://example.com/webhook/campaign-delivered",
    "webhook_open": "https://example.com/webhook/campaign-opened",
}

If you are using the create and send pattern then you can also use the params when creating the campaign via API

URL: https://external-api.xtremepush.com/api/external/create/campaign
POST DATA: 
{
    "apptoken": "APPTOKEN",
    ....,
    "webhook_delivery": "https://example.com/webhook/campaign-delivered",
    "webhook_open": "https://example.com/webhook/campaign-opened",
}

When a message, such as an email, is successfully delivered there will be a post-back to the webhook_delivery endpoint and if it is clicked/opened then there will be a post-back to the webhook_open endpoint. Data will take the following format:

 
{
     "time": TIMESTAMP_OF_EVENT,
     "device": {"id": DEVICE_ID},
     "profile": {"id": PROFILE_ID, "user_id": CUSTOMER_ID}   
     "send": {"id": SEND_ID},
     "campaign": {"id": CAMPAIGN_ID}
}

NOTE: when using the template and trigger pattern to do one-to-one messaging you can potentially construct unique post-back URLs for each execution if that suits your tracking use-case, for example:

"webhook_open": "https://example.com/webhook/some-unique-identifier"