Skip to main content
PUT
Atualizar uma assinatura de webhook

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string
obrigatório

Subscription id (UUID).

Exemplo:

"0190b5a0-0000-7000-8000-0000000000aa"

Corpo

application/json
active
boolean | null

Activation flag; a pointer so null/omitted leaves the stored value unchanged.

Exemplo:

true

description
string

New description; omitted leaves the stored value unchanged.

Exemplo:

"Primary settlement consumer"

events
string[] | null

Replacement event-type list; omitted leaves the stored list unchanged.

Exemplo:
headers
object

Replacement static HTTP headers; omitted leaves the stored headers unchanged.

secret
string

New raw signing secret; when present it rotates the signing secret (rehashed, never stored in cleartext). Omitted leaves it unchanged.

timeoutSeconds
integer<int32>

New per-delivery HTTP timeout in seconds; zero or omitted leaves it unchanged.

Exemplo:

10

url
string<uri>

New HTTPS endpoint; omitted leaves the stored value unchanged.

Exemplo:

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

Resposta

OK

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"