Skip to main content
POST
Registrar endpoint de webhook

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string

Idempotency key (canonical).

X-Idempotency-Key
string

Idempotency key (legacy alias).

X-TTL
string

Idempotency key TTL in seconds (overrides the configured default).

Exemplo:

"86400"

Corpo

application/json
eventTypes
string[] | null
obrigatório

Canonical control-plane event types to subscribe to (str.operation., str.readiness., str.certificate., str.approval.); at least one required.

Exemplo:
secret
string
obrigatório

Shared signing secret (16-512 chars); encrypted at rest with AES-256-GCM and never returned.

Exemplo:

"whsec_..."

url
string
obrigatório

HTTPS endpoint that receives event deliveries; max 2048 chars and subject to an SSRF check.

Exemplo:

"https://example.com/webhooks/str-events"

isActive
boolean

Whether the endpoint is active and eligible to receive deliveries; defaults to active when omitted.

metadata
object

Arbitrary client-defined key/value metadata stored with the endpoint.

Resposta

Created

correlationId
string
obrigatório

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Exemplo:

"550e8400-e29b-41d4-a716-446655440001"

webhook
object
obrigatório

The created, fetched, or updated webhook endpoint.