v1

latestOpenAPI 3.0.02026-07-1313126.3 KB

webhooks

Unsubscribe from webhook

This endpoint allows you to unsubscribe from a previously subscribed webhook event. Provide the event type and the callback URL to unsubscribe.

delete/webhooks/unsubscribe

Request body

type'NEW_RESPONSE' | 'PHONE_TRANSFER' | 'FOLDER_NEW_RESPONSE' | 'FOLDER_PHONE_TRANSFER' | 'ACTION_FAILED' required

The type of webhook event you want to unsubscribe from.

datastring

Optional data that was associated with the subscription.

urlstring required

The callback URL where the webhook was sending events.

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.