Last updated 2 minutes ago

Create and manage webhooks

You can create webhooks in the Attentive platform to send notifications to specified URLs when certain events occur. With webhooks, you can receive event notifications from Attentive and then your applications can act on these events. For example, your applications can act on an event when they:

  • Receive subscribe events from Attentive when users subscribe to SMS.
  • Receive unsubscribe events from Attentive when users unsubscribe to SMS.
  • Receive message send events from Attentive when Attentive sends a message to a subscriber.
  • Receive message click events from Attentive when a subscriber clicks a link in an SMS sent by Attentive.

On this page

Prerequisites

You must first create a custom app in order to create a webhook, then you can configure the settings for it.

Create a webhook

Complete the following steps to create a webhook:

  1. Navigate to the integrations setup page.
  2. Select the custom app (in the Built by you section) that you previously created for the webhook. The app’s Settings page appears.
  3. Click Webhooks to configure the webhook.
  4. Enter the URL in the HTTP Post URL field. You must specify the URL that receives event notifications from the webhook. Note that the URL requires https://.
  5. Click Save and generate signing key. This is a unique key.

    A unique key is automatically generated and can be shared between your application and Attentive to verify the events sent to your desired HTTP Post URL. Additionally, the Event Webhook Status setting is enabled as a result of the signing key being generated. For more information about the signing key, see Webhook authentication for details.
  6. Copy and save your signing key to a safe location.
  7. Click the Events drop-down.
  8. Select one or more of the following event options in the drop-down:

    • Phone

      • phone.unsubscribed—A notification is sent from Attentive when a user opts out of SMS.
      • phone.subscribed—A notification is sent from Attentive when a user subscribes to SMS.
    • SMS

      • sms.sent—A notification is sent from Attentive when a message is sent.
      • sms.message_link_click—A notification is sent from Attentive when a message link is clicked.
    • Email

      • email.unsubscribed—A notification is sent from Attentive when a user opts out of email.
      • email.subscribed—A notification is sent from Attentive when a user subscribes to email.

    In the following example, the user selected all phone and SMS events:

  9. Click Save. The webhook now sends notifications to the HTTP Post URL you configured for the relevant events you selected in the previous step.

Edit a webhook

Complete the following steps to edit an existing webhook:

  1. Navigate to the integrations setup page.
  2. Select the custom app (in the Built by you section) that you created specifically for the webhook. The app’s Settings page appears.
  3. Click Webhooks to edit the webhook for your app.
  4. (Optional) Edit the HTTP Post URL.
  5. (Optional) Edit the Events for each Engagement Data option.
  6. Click Save. The webhook is now updated.

Disable a webhook

Complete the following steps to disable your webhook so that you no longer receive notifications from Attentive:

  1. Navigate to the integrations setup page.
  2. Select the custom app (in the Built by you section) that you created for the webhook. The app’s Settings page appears.
  3. Click Webhooks to edit the webhook for your app.
  4. Scroll to the Event Webhook Status and click the toggle to disable it. The status appears as disabled.
  5. Click Save. The webhook is disabled.

Delete a webhook

If you need to delete your webhook, follow the steps to delete your custom app that was created for the webhook.