Skip to main content
POST
Configure outbound webhook

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

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.

Corpo

application/json
callbackUrl
string
obrigatório
enabledEvents
string[] | null
obrigatório
secret
string
obrigatório
active
boolean

Resposta

OK

active
boolean
obrigatório
callbackUrl
string
obrigatório
createdAt
string
obrigatório
enabledEvents
string[] | null
obrigatório
id
string
obrigatório
secret
string
obrigatório

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

Exemplo:

"[REDACTED]"

updatedAt
string
obrigatório