Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

id
string
required

Unique identifier of the webhook to update

Pattern: ^[0-9a-z]+$

Body

application/json

Request body for updating an existing webhook subscription

url
string<uri>

New HTTPS endpoint URL for webhook delivery

events
string[]

Updated list of subscribed event types

Event name or glob pattern. Examples: 'message.received', 'message.', 'call.ended', ''.

Required string length: 1 - 100
Pattern: ^[a-z0-9_*]+(\.[a-z0-9_*]+)*$
description
string

Updated human-readable label for this webhook

active
boolean

Set to false to pause webhook delivery without deleting

authConfig
object

Replace the endpoint auth; pass { type: 'none' } to remove it

rateLimitPerMinute
integer | null

Max deliveries/minute; null clears it (unlimited)

Required range: 0 <= x <= 100000
maxAttempts
integer | null

Max delivery attempts; null resets to platform default (3)

Required range: 1 <= x <= 10

Response

200 - application/json

OK

Webhook subscription resource

id
string
required

Unique identifier for the webhook

Pattern: ^[0-9a-z]+$
orgId
string
required

Organization that owns this webhook

Pattern: ^[0-9a-z]+$
url
string<uri>
required

HTTPS endpoint URL receiving webhook payloads

events
string[]
required

Event types this webhook is subscribed to

Event name or glob pattern. Examples: 'message.received', 'message.', 'call.ended', ''.

Required string length: 1 - 100
Pattern: ^[a-z0-9_*]+(\.[a-z0-9_*]+)*$
active
boolean
required

Whether the webhook is currently active

description
string | null
required

Human-readable label for this webhook

consecutiveFailures
integer
required

Number of consecutive delivery failures across all events

Required range: x >= 0
disabledReason
string | null
required

Reason the webhook was auto-disabled, null if manually disabled or active

disabledAt
string<date-time> | null
required

ISO 8601 timestamp when the webhook was auto-disabled

createdAt
string<date-time>
required

ISO 8601 timestamp when the webhook was created

updatedAt
string<date-time>
required

ISO 8601 timestamp when the webhook was last modified

authType
enum<string>
required

Auth scheme the platform presents to your endpoint (never includes the secret)

Available options:
NONE,
BEARER,
BASIC,
CUSTOM_HEADER
authHeaderName
string | null
required

Header name for CUSTOM_HEADER auth; null for other schemes

rateLimitPerMinute
integer | null
required

Per-endpoint delivery rate cap in requests/minute; null = unlimited

maxAttempts
integer | null
required

Per-webhook max delivery attempts; null = platform default (3)