Webhooks

A webhook enables real-time notifications for message delivery status, allowing you to track the status of your campaign based on the events. To receive notifications on SMS messages via Webhooks, you need to register at https://webhook/URL.

Set up endpoints/customer specific URL

A webhook endpoint receives requests from Interact, notifying you about events related to your SMS campaign such as messages submitted, failed, and delivered. You can navigate to the Webhook site to start configuring the endpoint. Add the customer-specific Webhook URL that you want to use to configure the endpoint. For example, let's use https://webhook.site/url as an endpoint.

Verify webhook endpoint

To retrieve the “webhook site endpoint” secret, you might need to verify the URL and set up the webhook correctly. After you have a basic webhook endpoint ready to accept events from Interact, you can add the application logic that your business needs to handle the events.

After creating a secret, the URL at https://webhook.site/{token.uuid} is verified and becomes accessible to get and store real-time notifications. You can also extend your endpoint with signatures to authenticate requests.

Signature

After you retrieve your endpoint's secret from your Interact Webhook, Secure your endpoint with signatures to authenticate requests. Secure your webhook with a client signature to validate the events that are generated from Interact and not from any other third party. You can use SHA algorithms to verify a signature.

Choose Topics

While configuring a webhook, use the Topics section to choose which events will send you webhook notifications. You can also subscribe to all current and future events.

Choose the events that trigger certain events. Specify the webhook details such as Name, Endpoint, Topics, and so on. Each event corresponds to a certain set of actions. For example, if you subscribe to the delivered event you'll receive a detailed report every time a message is successfully delivered to a customer.
After the webhook is configured successfully, you can retrieve the status as per topics using the Webhook URL.

For example, let's select the channel as SMS, the sender, and the event as Submitted. The users will receive webhook notifications when an SMS message is submitted by the sender number.

Notifications on webhook site

After the webhook is configured successfully, you can retrieve the status based on topics and selected events. You can retrieve details about the list of SMS messages with specific information on the type of events, tracking, sending, and delivery. To view the notification, go to Webhook.site - Test, process and transform emails and HTTP requests site.