Campaign Execution Status Webhook

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

Please note:

  1. This feature is supported only for event-triggered campaigns, including API triggered campaigns.
  2. Your webhook URL should handle a POST request with a JSON body. It needs to respond with a 200 HTTP status code on success. 
  3. 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.
  4. If the user is successfully messaged, we send a request with status as "success" and on any failures we send a request with status as "failed" along with an error message.

1. Webook Configuration

You can provide the URL in the Account > Webhooks tabs under "Campaign execution status webhook"

https://app.getblueshift.com/dashboard#/app/account/integrations

Screen_Shot_2018-09-04_at_11.39.14_AM.png

2. Sample Requests

Please find some sample requests below:

1. On Success

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

2. On Failure

{
  "campaign_name": "Welcome Onboarding Predictive Journey",
  "campaign_uuid": "1b2cd2e8-b89b-4c99-826d-ef45a052e9d9",
  "user": {
    "email": "test@test.com",
    "customer_id": "C12345"
  },
  "status": "failed",
  "error_message": "error message",
  "error_code": 502,
  "payload": {
    "email": "test@test.com",
    "order_id": 791542,
    "trans_type": "update_order",
    "source": "concert"
  }
}
  • payload: The original event which was used to trigger the campaign
  • user: User info
  • error_message: On failure, contains additional information on the error
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request