Information for: DEVELOPERS   PARTNERS

Webhooks

A webhook is an HTTP callback which enables you to send data from one application to another. Webhooks are like APIs when it comes to passing data, but an API request generates a response. Webhooks don’t require requests, so the data can send when it’s available. To send data from Campaign Studio to your application, you first must ensure you have a URL in place for your application that can accept data. If you are unsure, check with your dev or IT team if this is possible within your company.

Campaign Studio can send the following events through a webhook:

  • Contact Channel Subscription Change Event
  • Contact Deleted Event
  • Contact Identified Event
  • Contact Points Changed Event
  • Contact Updated Event
  • Email Open Event
  • Email Send Event
  • Form Submit Event
  • Page Hit Event
  • Text Send Event

To set up a new webhook, perform the following steps:

  1. Sign in to your Campaign Studio account.
  2. Open the right panel to see Platform settings.
  3. Click Webhooks.
  4. Click New.
  5. Add a Name and Webhook description. The Secret generates if no value is provided, to verify the authenticity of the webhook payload on the target server.
  6. Take the Post URL from your application and paste it into the Webhook post URL field.
  7. Select the check box for event you’d like to fire the webhook on.
  8. Click Send Test Payload to test the webhook. If the application receives the webhook, a Success (200) message displays. If the message fails, you must ensure the Webhook Post URL is configured to receive data.
  9. After a successful test, click Save and close the webhook.

Create a new webhook dialog box

Click an existing webhook to review the webhook posts. You’ll see the ID, Response, Date, Request Runtime, and Notes about the webhook. You may set the order of queued events for each Webhook to the default, chronological, or reverse chronological order. Configure the order in Settings > Configuration > Webhook Settings.

image1