Webhook for campaign execution status

You can use the campaign execution status webhook to track the execution status of an event-triggered campaign. This webhook is a URL that you provide to consume data on your side. The webhook URL is pinged with the results of each step of the campaign journey that the user qualifies for.

Note:

This feature is supported only for event-triggered campaigns, including API triggered campaigns.
Your webhook URL should handle a POST request with a JSON body. It needs to respond with a 200 HTTP status code on success.
Your webhook URL only gets notified if the user qualifies for a trigger. This means if the user reaches a point in the campaign where they no longer qualify for any triggers (usually due to trigger filters), your webhook URL will not be notified.
If a message is successfully sent to a user, we send a request with status as success. On failures, we send a request with status as failed along with an error message.

Webhook configuration

You can provide the URL on the Campaign Activity Export tab of the Account Profile page. To access the page, sign in to the Blueshift app > your name on the top-right corner > Account Profile > Campaign Activity Export.

Sample requests

On success:

{
  "campaign_name": "Welcome Onboarding Predictive Journey",
  "campaign_uuid": "1b2cd2e8-b89b-4c99-826d-ef45a052e9d9",
  "user": {
    "email": "[email protected]",
    "customer_id": "C12345"
  },
  "status": "success",
  "message": "message sent"
}

On failure:

{
  "campaign_name": "Welcome Onboarding Predictive Journey",
  "campaign_uuid": "1b2cd2e8-b89b-4c99-826d-ef45a052e9d9",
  "user": {
    "email": "[email protected]",
    "customer_id": "C12345"
  },
  "status": "failed",
  "error_message": "error message",
  "error_code": 502,
  "payload": {
    "email": "[email protected]",
    "order_id": 791542,
    "trans_type": "update_order",
    "source": "concert"
  }
}

payload: The original event that was used to trigger the campaign
user: User info
error_message: On failure, contains additional information on the error