Skip to main content
POST
Configure outbound webhook

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id
string

Tenant organization ID. Optional. The organization context is determined by the credentials you authenticate with; this header does not select or change it.

Idempotency-Key
string
required

Client-supplied idempotency key, a UUID. Required: a request without it, or with a value that is not a UUID, is refused with 400 PBP-0012.

Body

application/json
callbackUrl
string
required
enabledEvents
string[] | null
required
secret
string
required
active
boolean

Response

OK

active
boolean
required
callbackUrl
string
required
createdAt
string
required
enabledEvents
string[] | null
required
id
string
required
secret
string
required

Always the literal "[REDACTED]" — the signing secret is never returned by this API.

Example:

"[REDACTED]"

updatedAt
string
required