Skip to main content
PATCH
Update Webhook

Authorizations

X-API-Key
string
header
required

Workspace API key (e.g. kej_live_...)

Path Parameters

webhook_id
string
required

Body

application/json

Partial update for a webhook subscription (public API).

name
string | null
url
string<uri> | null
Required string length: 1 - 2083
events
string[] | null
signing_method
enum<string> | null

Webhook signing methods.

Available options:
hmac_sha256,
hmac_sha1,
bearer,
basic_auth,
none
scope_type
enum<string> | null

Webhook scope types.

Available options:
global,
persona
persona_id
string | null
timeout_ms
integer | null
Required range: 1000 <= x <= 30000
max_retries
integer | null
Required range: 0 <= x <= 10

Response

Successful Response

Webhook subscription response (public-safe).

id
string
required
url
string
required
events
string[]
required
signing_method
enum<string>
required

Webhook signing methods.

Available options:
hmac_sha256,
hmac_sha1,
bearer,
basic_auth,
none
scope_type
enum<string>
required

Webhook scope types.

Available options:
global,
persona
delivery_settings
WebhookDeliverySettings · object
required

Delivery configuration for a webhook subscription.

stats
WebhookStats · object
required

Delivery statistics for a webhook subscription.

name
string | null
persona_id
string | null
last_delivery_at
string | null
last_error
string | null
created_at
string | null
updated_at
string | null