Saltar al contenido principal
PATCH
Edit a hub subscription

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization
string

Bearer token, relayed to the streaming-hub as server-to-server auth.

X-Idempotency
string
requerido

Idempotency key, forwarded to the hub's idempotency middleware, which refuses this mutation without one.

If-Match
string

The ETag a read of the subscription returned. When the subscription changed since, the edit is refused 412 subscription_changed. Absent means the last write wins.

Ejemplo:

"\"1700000000123456\""

Parámetros de ruta

id
string
requerido

Subscription id.

Cuerpo

application/json
schema_major
integer<int64> | null
requerido

Schema major to pin to, or null to clear the pin (follow base). Required on every edit.

Ejemplo:

2

endpoint
string

New delivery destination, validated as at create. An active subscription moves only after the new destination answers a verification probe.

Ejemplo:

"https://hooks.example.com/ingest"

event_majors
object

New schema major per event type, replacing the overrides; {} clears them. Omit to keep them.

event_types
string[] | null

New subscribed event types, replacing the list; ["*"] or [] means all events. Omit to keep them.

name
string

New subscription name. Omit to keep it.

Ejemplo:

"orders-webhook"

timeout_ms
integer<int64>

Per-attempt delivery timeout in milliseconds, 1000 to 20000, webhook subscriptions only; 0 gives it up. Omit to keep it.

Ejemplo:

20000

Respuesta

OK