POST /api/v2/webhooks
Creates a new webhook for your company.
An unique webhook ID will be generated when successfully creating a webhook. A webhook ID is to be required when creating event subscriptions. One webhook ID can be shared between multiple event subscriptions. When triggered, events will be sent to the provided hook_url under webhook. If a secret is provided, the webhook events will be encoded and signed in the JWT format using the shared secret with the HS256 algorithm. The JWT payload should be decoded and the signature verified to ensure that the event came from Dialpad. If no secret is provided, unencoded events will be sent in the JSON format. It is recommended to provide a secret so that you can verify the authenticity of the event.
Added on April 2nd, 2021 for API v2.
Rate limit: 100 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
hook_url |
String | Yes |
The webhook's URL. Triggered events will be sent to the url provided here. |
secret |
String | No |
[single-line only] Webhook's signature secret that's used to confirm the validity of the request. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.