Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

id
string<uuid>
required

Webhook endpoint ID.

Body

application/json
label
string

New endpoint label. Unique per account. The reserved default label cannot be assigned manually, and the default endpoint cannot be renamed away from it.

Pattern: ^[a-z0-9][a-z0-9-]{0,30}$
url
string<uri>

New HTTPS webhook URL.

enabled
boolean

Whether this endpoint should receive new webhook events.

events
enum<string>[]

Replacement event allowlist. Send [] to receive every event type. The whole array is validated, so it must contain only currently valid event names.

A webhook event type. This is the complete catalog and the only set accepted in an endpoint's events allowlist. webhook.test is deliberately absent: it is fired only by POST /config/webhooks/{id}/test and always reaches the endpoint being tested regardless of its allowlist. There is no session.failed event — a session that ends in a terminal failure is delivered as session.completed with duration_seconds: 0, transcript: null, and a terminal call.status.

Available options:
session.completed,
call.status.updated,
call.transferred,
whatsapp.message.sent,
whatsapp.message.failed,
whatsapp.message.status_updated

Response

Webhook endpoint updated.

success
boolean
data
object