Sign in

v1

latestOpenAPI 3.0.02026-07-1313126.3 KB
webhooks

Subscribe to webhook

This endpoint allows you to subscribe to a specific webhook event (e.g., new call responses or phone transfers). You must provide the event type and a callback URL.

post/webhooks/subscribe

Request body

type'NEW_RESPONSE' | 'PHONE_TRANSFER' required

The type of webhook event to subscribe to. Choose 'NEW_RESPONSE' for new call responses or 'PHONE_TRANSFER' for phone call transfers.

datastring nullable

Additional data that can be included with the webhook event. This is optional.

urlstring uri required

The callback URL where the webhook should send the event.

Example request

{
  "type": "NEW_RESPONSE"
}

Response

Successful response

errorobject nullable

An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.

dataobject required

Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.