Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

endpoint_id
string
required

The ID of the webhook endpoint to update (e.g. whe_...).

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Body

application/json
name
string | null

Updated display name for the webhook endpoint.

Required string length: 1 - 120
labels
string[]

Updated tag-style purpose labels for the endpoint.

Maximum array length: 8
url
string

New URL for the webhook endpoint. Must use https:// (http:// is only accepted for localhost in development).

Maximum string length: 2048
enabled
boolean

New enabled state for the webhook endpoint.

subscribed_event_types
enum<string>[]

The updated event subscriptions for the endpoint.

Available options:
verification.session.succeeded,
verification.session.failed,
verification.session.expired,
verification.session.cancelled
undelivered_payload_retention_hours

How long Kayle should retain encrypted undelivered payloads after terminal delivery failure.

Available options:
0

Response

Successful operation.

data
object
required
error
null
required