Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

A gbr_pat_ access token. Scopes are recorded on the token when it is minted.

Headers

Idempotency-Key
string

Retrying with the same key replays the first answer instead of acting again.

Maximum string length: 255

Body

application/json
url
string
required

https only.

events
string[]

Empty or absent means every event.

Response

Subscribe an endpoint to session events.

The secret appears in this response only. Store it; it cannot be shown again.

object
string
required

Always webhook.subscription. Names the shape, so a value can be identified without knowing which call returned it.

Allowed value: "webhook.subscription"
id
string
required

Ours. Use it to delete the subscription.

url
string
required

Where deliveries go. Must be https.

events
string[]
required

Which events to deliver. An empty list means all of them.

secret
string
required

Recompute x-gobare-signature as HMAC-SHA256 over <timestamp>.<body>.

active
boolean

False once deliveries have been given up on. See webhooks.md on retries and dead letters.