Skip to main content
POST
cURL
Creates a new webhook subscription. Webhooks allow you to receive real-time HTTP POST notifications when specific events occur in your account.

Request Body

FieldTypeRequiredDescription
namestringYesA descriptive name for the webhook
urlstringYesThe URL to receive webhook POST requests (must be a valid URL)
eventsstring[]YesArray of event types to subscribe to
dispositionsnumber[]NoFilter CALL_LOGGED events by disposition IDs. If provided, only calls with matching dispositions will trigger the webhook.

Available Events

EventDescription
CALL_LOGGEDTriggered when a user logs a call, capturing relevant call details
CONTACT_SNOOZEDTriggered when a contact is snoozed, capturing the contact and snooze details

Example Request

Response (201)

Returns the created webhook object.

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

A descriptive name for the webhook

url
string<uri>
required

The URL to receive webhook POST requests

events
enum<string>[]
required

Event types to subscribe to

Available options:
CALL_LOGGED,
CONTACT_SNOOZED
dispositions
integer[]

Filter CALL_LOGGED events by disposition IDs

Response

201 - application/json

Webhook created successfully

The response is of type object.