Edit a hub subscription

Edits a subscription’s name, endpoint, event types, event majors, schema major and timeout; it keeps its id, secret, kind and origin. schema_major is required (null clears the pin); every other field is optional and only what is sent changes. A new endpoint moves an active subscription only after it answers a verification probe (422 destination_probe_failed, nothing changes). Send the ETag of a read as If-Match: another operator’s edit in between answers 412 subscription_changed; without If-Match the last write wins. A refusal keeps the hub’s status and carries the hub’s own code in upstream.code: branch on that code, not on the status.

PATCH /v1/subscriptions/{id}

Edit a hub subscription

cURL

curl --request PATCH \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "schema_major": 2,
  "endpoint": "https://hooks.example.com/ingest",
  "event_majors": {},
  "event_types": [
    "<string>"
  ],
  "name": "orders-webhook",
  "timeout_ms": 20000
}
'

404

{
  "code": "AUT-0033",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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.

Show child attributes

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

200

OK