Get a webhook subscription

GET 
/v1/webhooks/:webhook_id

Fetch one webhook subscription by webhook_id. Requires the connector:webhooks:read scope.

Returns the callback url, the subscribed event_types, the delivery_format, the current status and the bound auth profile (relationships.auth_profile, data: null when none is bound). The signing secret is never returned.

Check status after creating a subscription or binding an auth profile: it moves from PENDING_VERIFICATION to ACTIVE once your endpoint has answered the webhook.verification handshake with a 2xx status.

Request

Responses

200

The requested webhook subscription.

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.

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.