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. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.

Idempotency-Key
string

Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header 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