Skip to main content
POST
Create a webhook endpoint bound to an agent

Authorizations

Authorization
string
header
required

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

Path Parameters

agentId
string<uuid>
required

Agent ID to bind the endpoint to.

Body

application/json
label
string
required

Your chosen endpoint label. Lowercase letters, numbers, and hyphens only; 1-31 characters. Unique per account.

Pattern: ^[a-z0-9][a-z0-9-]{0,30}$
Example:

"acme-tenant"

url
string<uri>
required

HTTPS URL that receives webhook events.

Example:

"https://acme.example.com/vocobase"

enabled
boolean
default:true

Whether the endpoint should receive new webhook events.

events
enum<string>[]

Event allowlist. Omit or send [] to receive every event type.

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 created. Save the secret immediately.

success
boolean
data
object