Skip to main content
POST
Registrar uma assinatura de webhook

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

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

Business event types this subscription is delivered.

Exemplo:
url
string<uri>
obrigatório

HTTPS endpoint that receives webhook deliveries for the request tenant.

Exemplo:

"https://client.example.com/webhooks/slc"

active
boolean

Whether the subscription is active and eligible for delivery.

Exemplo:

true

description
string

Optional human-readable label for the subscription.

Exemplo:

"Primary settlement consumer"

headers
object

Optional static HTTP headers added to every delivery request to this endpoint.

secret
string

Raw signing secret used only to derive the SHA-256 HMAC signing key; never persisted or echoed in cleartext. In BYOC the real signing secret comes from the client's Kubernetes Secret.

timeoutSeconds
integer<int32>

Optional per-delivery HTTP timeout in seconds; omitted or zero applies the service default (10s).

Exemplo:

10

Resposta

Created

active
boolean
obrigatório

Whether the subscription is active and eligible for delivery.

Exemplo:

true

createdAt
string<date-time>
obrigatório

Subscription creation timestamp (RFC3339, UTC).

Exemplo:

"2026-06-15T07:50:00Z"

events
string[] | null
obrigatório

Business event types this subscription is delivered.

Exemplo:
failureCount
integer<int64>
obrigatório

Cumulative count of failed delivery attempts.

Exemplo:

3

id
string
obrigatório

Subscription id (UUID).

Exemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

lastDeliveryAt
string<date-time> | null
obrigatório

Timestamp of the most recent delivery attempt (RFC3339, UTC); null when none has occurred.

Exemplo:

"2026-06-15T07:50:00Z"

lastDeliveryStatus
integer<int32> | null
obrigatório

HTTP status code of the most recent delivery attempt; null when none has occurred.

Exemplo:

200

successCount
integer<int64>
obrigatório

Cumulative count of successful deliveries.

Exemplo:

128

updatedAt
string<date-time>
obrigatório

Subscription last-update timestamp (RFC3339, UTC).

Exemplo:

"2026-06-15T07:50:00Z"

url
string
obrigatório

HTTPS endpoint that receives webhook deliveries.

Exemplo:

"https://client.example.com/webhooks/slc"

description
string

Human-readable label for the subscription.

Exemplo:

"Primary settlement consumer"