Using Webhooks

Webhooks allow you to get programmatic notifications from Tape about activity from your campaign as they happen. If you’re unfamiliar with webhooks, read this guide to learn more.

Rather than requiring you to pull information via our API, webhooks will push information to your endpoint. When one of those events is triggered (for example when a prospect taps the CTA), Tape will send this notification as an HTTP `POST` request, with a JSON body, to the endpoint(s) you specify.

Setting up a Webhook

You can create a new webhook in the Tape web app via Settings > Developer Settings. Each webhook can determine which events to subscribe to.

Available Events

Event Name Description
all Anytime any event is triggered
contact_opt_out Triggered when an opt out is detected from a customer sms response
contact_unreachable Triggered when an outreach could not be sent due to the provided number not being detected as a mobile number
outreach_sent Triggered when an outreach is sent to the mobile number provided
video_link_opened Triggered when a prospect taps on the link to the Tape player from the SMS message
video_cta_clicked Triggered when the prospect taps on the CTA button at the bottom of the video player
video_next_clicked Triggered when the prospect taps the right side of the video player to advance to the next video
video_paused Triggered when the prospect pauses the video player
video_previous_clicked Triggered when the prospect taps the left side of the video player to navigate to the previous video
video_playing Triggered when the prospect plays the video

Webhook Format

{
  "data": {
    "contact": {
      "name": "Dave Schatz",
      "phoneNumber": "+12015551234",
      "countryCode": "US",
      "optedOut": false
    },
    "outreachId": "E1XXXXXXXXXX",
    "timestamp": "2019-06-11T19:21:05.760Z"
  },
  "eventType": "outreach_sent"
}

Testing

If you’re looking for a simple and convenient way to test webhooks, consider setting up an endpoint at webhook.site and subscribing that to see events come through.

For more advanced testing, you may want to look into something like ngrok to proxy connections to a local development environment.

Don’t forget to remove your test subscriptions when you’re done testing!

Next Steps

Congratulations on getting your webhook set up and firing properly. You can either set up you application to listen for these events directly or you can route these callback through Zapier to take advantage of integrations into CRMs and other software tools!