Skip to main content
Webhook Management
Updated over a week ago

In the Webhooks section, you can:

  • create, edit, or delete webhooks for short URL clicks in messages, incoming or delivery messages

  • view webhooks automatically generated by third-party applications

  • turn the webhooks on or off

What is a webhook?

A webhook is a way for an application to immediately deliver real-time data to other applications. It’s more efficient than APIs: APIs send requests and receive responses, while webhooks don’t require requests. They send data when it’s available.

You can set up webhooks in the CommPeak SMS platform and configure it to send data to an external system. For example, when you get an incoming message, the platform can forward the message data to any third party to perform analysis and take further action.

To configure webhooks, expand Webhooks in the main menu and go to Management.

Here, you can view a table with your data on webhooks and apply search filters:

If you'd like to turn off a webhook temporarily, you can use the slider control at the beginning of the row. Besides editing and deleting a specific webhook, the Actions column lets you display a request preview.

To create a webhook:

  1. Click Add Webhook at the top-right of the page.


    If you haven't added any webhooks yet, click Add Webhook on the empty page.

  2. The Create new webhook form will load. Fill in the details and configure the new webhook.

    • In Webhook Details, enter a name and select a trigger:

      • Webhook name: enter a meaningful title to locate the webhook quickly.

      • Trigger: choose from the drop-down list whether you want to trigger it by an incoming or delivery message or a short URL click.

      • In Message status change (for delivery message type only), select how you want to receive notifications:

        • Single: receive a status change notification for every message

        • Bulk: aggregate status change notifications in batch requests for every 100 messages to avoid the risk of being flagged as an attack by some servers.

      • Filter Stream (for incoming or delivery message types only) - select a stream API or several streams for which you want to create webhooks.

    • In Endpoint Configuration, enter the endpoint URL. Optionally add HTTP headers.

      • URL - select the GET or POST method and enter the URL to which you want to send data.

      • HTTP Headers - optionally, enter the key name and value.

  3. The requests' preview is available on the right. You can copy the request body immediately.

  4. Click Create Webhook.

Did this answer your question?