Skip to main content
PATCH
Rename, enable or disable a webhook

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Path Parameters

webhookId
string<uuid>
required

A webhook id from GET /v1/webhooks.

Body

application/json
name
string

A label for the destination (1 to 100 characters).

Required string length: 1 - 100
Example:

"Ops alerts"

enabled
boolean

Response

The updated webhook.

id
string
required
name
string
required
url
string
required

Where deliveries are POSTed. Treat it as a secret.

enabled
boolean
required
createdAt
string
required

ISO-8601 UTC timestamp.

signingSecret
string
required

The secret each delivery is signed with: verify X-Jam-Signature = v1= + hex HMAC-SHA256(signingSecret, ${X-Jam-Timestamp}.${raw body}).

Example:

"whsec_3f1c..."