Skip to main content
POST
Add a webhook

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

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

Required string length: 1 - 100
Example:

"Ops alerts"

url
string<uri>
required

A public https URL. Private, loopback and cloud metadata addresses are refused.

Example:

"https://hooks.example.com/jam"

enabled
boolean

Defaults to true.

Response

The new 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..."