Update a webhook subscription

PUT 
/v1/webhooks/:webhook_id

Request a change to a subscription's url, event_types, delivery_format or status (ACTIVE or DISABLED). Requires the connector:webhooks:update scope and an Idempotency-Key header. data.id must be the webhook_id of the path.

Send only the attributes to change; at least one is required, otherwise the request is rejected with 422 MISSING_ANY_OF. A new url must be an absolute https:// URL with a host. delivery_format, when sent, must be jsonapi. security.transport.mtls_required is accepted but currently has no effect: the platform does not present a client certificate on deliveries.

Returns 202 Accepted with an operation; follow it with GET /v1/operations/{operation_id}. This request does not change the signing secret; use POST /v1/webhooks/{webhook_id}/rotate-secret for that.

Request

Responses

202

Accepted. The operation (data.id) tracks the update.

400

The request is malformed: invalid JSON syntax, an invalid path or query parameter, a missing required header such as Idempotency-Key, or a single field that fails its own format rule. Fix the request before retrying; retrying it unchanged fails again.

401

The bearer token is missing, malformed, expired, signed by an unknown key, or was not issued by the platform IAM for the Lyriq Connector. Obtain a new token and retry. See the Authentication section.

403

The token is valid but may not perform this request: it lacks the required scope, has no bank membership, needs an x-dan-bank-id header to choose between several memberships, names a bank in x-dan-bank-id it has no membership for, or the caller's bank is suspended or terminated. A new token with the same configuration fails the same way. See the Authentication section.

404

The resource does not exist, or it belongs to another bank. The Lyriq Connector does not distinguish the two cases, so resources of other banks are never disclosed.

409

The request conflicts with an earlier request or with the current state of the target: an Idempotency-Key reused with a different body (IDEMPOTENCY_CONFLICT), a request with the same key still in progress (IDEMPOTENCY_PENDING), or a target resource in a state that does not allow the request (STATE_CONFLICT).

422

The body does not match the schema (for example an unknown attribute), or no attribute to update was sent (MISSING_ANY_OF).

429

The request was refused because a rate limit was reached (code RATE_LIMITED). No Retry-After header is sent; retry with exponential backoff.

503

The request could not be served right now. Either the network is not fully operational (OUTBOUND_HALTED or READ_ONLY: mutations are refused while read endpoints keep working; OPERATIONAL_STATE_UNKNOWN: the state could not be determined), or a platform dependency is temporarily unavailable. No Retry-After header is sent; retry later with backoff. When retrying a mutation, reuse the same Idempotency-Key and body.