Skip to main content
PATCH
Update the webhook endpoint

Authorizations

Authorization
string
header
required

Your Wixzel Phone API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Body

application/json
url
string<uri>

HTTPS URL we POST events to. It must resolve to a public address: a URL pointing at loopback, link-local or private space is refused here and again at delivery time, because this server can reach addresses you cannot.

Maximum string length: 2000
Example:

"https://example.com/hooks/wixzel"

enabled
boolean
events
enum<string>[]

Replaces the subscription entirely. Send the full list you want, not a delta.

Minimum array length: 1

The value of the event field in the delivered payload.

Available options:
inboundCall,
outboundCall,
callCompleted,
leadCreated,
leadQualified,
campaignCompleted,
appointmentBooked,
appointmentCanceled,
callTransferred,
transferFailed

Response

The updated configuration

object
enum<string>
required
Available options:
webhook
url
string | null
required

Null until you set one. No events are sent while it is null.

enabled
boolean
required

The master switch. False sends nothing, whatever events says.

events
enum<string>[]
required

The events you are subscribed to. An account that has never configured webhooks is subscribed to all of them.

The value of the event field in the delivered payload.

Available options:
inboundCall,
outboundCall,
callCompleted,
leadCreated,
leadQualified,
campaignCompleted,
appointmentBooked,
appointmentCanceled,
callTransferred,
transferFailed
secret_set
boolean
required

Whether a signing secret exists. The secret itself is never returned — rotate it to see a new one.