Skip to main content
PUT
Update a webhook subscription

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id
string
requerido

Subscription id (UUID).

Ejemplo:

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

Cuerpo

application/json
active
boolean | null

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

Ejemplo:

true

description
string

New description; omitted leaves the stored value unchanged.

Ejemplo:

"Primary settlement consumer"

events
string[] | null

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

Ejemplo:
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.

Ejemplo:

10

url
string<uri>

New HTTPS endpoint; omitted leaves the stored value unchanged.

Ejemplo:

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

Respuesta

OK

active
boolean
requerido

Whether the subscription is active and eligible for delivery.

Ejemplo:

true

createdAt
string<date-time>
requerido

Subscription creation timestamp (RFC3339, UTC).

Ejemplo:

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

events
string[] | null
requerido

Business event types this subscription is delivered.

Ejemplo:
failureCount
integer<int64>
requerido

Cumulative count of failed delivery attempts.

Ejemplo:

3

id
string
requerido

Subscription id (UUID).

Ejemplo:

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

lastDeliveryAt
string<date-time> | null
requerido

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

Ejemplo:

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

lastDeliveryStatus
integer<int32> | null
requerido

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

Ejemplo:

200

successCount
integer<int64>
requerido

Cumulative count of successful deliveries.

Ejemplo:

128

updatedAt
string<date-time>
requerido

Subscription last-update timestamp (RFC3339, UTC).

Ejemplo:

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

url
string
requerido

HTTPS endpoint that receives webhook deliveries.

Ejemplo:

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

description
string

Human-readable label for the subscription.

Ejemplo:

"Primary settlement consumer"