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

webhook_id
string<uuid>
required

Query Parameters

rotate_secret
boolean
default:false

Issue a new signing secret.

Body

application/json

Body for PATCH /v1/webhooks/{id}.

url
string | null

New endpoint URL.

events
string[] | null

Replace the event filter list. Pass [] to receive all events.

enabled
boolean | null

Enable or disable delivery.

Response

Successful Response

Registered webhook endpoint.

id
string
required

Opaque webhook identifier (UUID).

Example:

"aaaa0001-bbbb-0002-cccc-000300040005"

url
string
required

HTTPS endpoint Kallima delivers events to.

Example:

"https://your-service.example.com/webhooks/kallima"

enabled
boolean
required

Whether deliveries are being attempted.

created_at
string
required

ISO-8601 creation timestamp (UTC).

updated_at
string
required

ISO-8601 last-updated timestamp (UTC).

object
string
default:webhook

Polymorphic discriminator. Always webhook.

events
string[] | null

Subscribed event types. null means all events.

secret
string | null

Webhook signing secret. Returned only at creation time — subsequent reads omit this field. Store it immediately; it cannot be recovered. Rotate via PATCH rotate_secret=true.

Example:

"whsec_AbCdEfGhIjKlMnOpQrStUvWx1234567890ABCDEF"