URL destination webhook

The client-defined API is triggered with information about the current call whenever the URL destination is reached in route resolution. The expected response is a valid endpoint destination.

postWebhookreceive-url-destination-request

Headers

Authorizationstring

Authentication generated based on route configuration. Basic and HMAC are supported.

Payload

applicationIdstring

Identifier of the application that originated the call.

routeIdstring

Identifier of the route that is used to process the call.

callIdstring

Identifier of the call that is being processed.

fromstring

Phone number from which the call originated from.

tostring

Destination phone number of the call.

startTimestring date-time

Timestamp representing start time of the call.

Example payload

{
  "routeId": "f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
  "callId": "d8d84155-3831-43fb-91c9-bb897149a79d",
  "from": "44790123456",
  "to": "44790123456",
  "startTime": "2024-01-01T10:00:00Z"
}

Response

Success

type'APPLICATION' | 'ENDPOINT' | 'URL' required

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.