Webhook
Webhooks are user-defined callbacks that are triggered by specific events. They assist in starting the execution of a specific task when specific actions occur and pushing data from one application or server to another when an event occurs (also called trigger). Furthermore, they respond in real-time, eliminating delays in accessing critical information. You can configure Webhook by specifying the HTTP Method, the URL to receive data, and the trigger options, which are all detailed below.
To add a webhook, follow these steps:
-
Click on Services > Webhook tab placed on the side-navigation.
-
Click on Add Webhook on top-right of the page.
- Enter the general details as per the fields described in the table below.
Field | Description |
---|---|
Name | Enter the name of the Webhook. |
Description | Enter the description for Webhook. |
Trigger | Choose the trigger from the dropdown. A trigger is a predefined action or a notification that activates Webhook. The triggers or automated processes listed below are generated for both inbound and outbound calls, and they are as follows:
|
URL | Enter the URL that will be used to provide HTTP callbacks for the Webhook. |
Request | Select request from either of the following options: POST or GET. Note: The exchange of data happens over the web through an HTTP request, using GET & POST methods. |
Call Type | Select the required Call Type from either of the following options: |
Content-Type | Select the Content-Type that contains the data from either of the following body types: |
My Numbers | Select the DID numbers from the dropdown. |
Time Zone | Select the time zone for the webhook. |
Note: While configuring the triggers, Webhook sends an HTTP request encompassing various parameters to different endpoints. These parameters form the Response Body as demonstrated in the screenshot. Also, the parameters change as per the selected trigger.
- Click Add header to add new header, enter the Key and the Value to insert additional values in the Response Body.
- Click Save.
Updated 6 months ago