List webhook subscriptions

GET 
/v1/webhooks

List the webhook subscriptions registered by the calling bank. Requires the connector:webhooks:list scope. Only subscriptions owned by the caller's bank are returned.

A webhook subscription tells the platform to POST signed JSON event notifications to an HTTPS URL that your bank operates. Each subscription has:

• url: the HTTPS endpoint that receives deliveries;
• event_types: the event types it receives (exact, case-sensitive matches; see POST /v1/webhooks for the full list and the delivery contract);
• status: PENDING_VERIFICATION until the endpoint has acknowledged the webhook.verification handshake event, then ACTIVE. Only ACTIVE subscriptions receive business events;
• an optional bound auth profile (relationships.auth_profile), which makes the platform obtain an OAuth2 access token from your token endpoint and send it as Authorization: Bearer on every delivery.

Signing secrets are never returned.

Ordering and pagination. Results are ordered newest first (by id, a time-ordered UUID). Use page[size] (1 to 200, default 20) and follow links.next until it is absent.

Request

Responses

200

One page of the calling bank's webhook subscriptions, newest first.

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.

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.