Send a test event to a webhook

POST 
/v1/webhooks/:webhook_id/test

Request a synthetic webhook.test event for a subscription, to check connectivity, TLS, bearer-token handling and signature verification before relying on real events. Requires the connector:webhooks:test scope and an Idempotency-Key header.

data.attributes.event_type is required (the request is rejected with 400 MISSING_FIELD without it). It must be a supported webhook event type. It is recorded with the request but does not change the delivered body: the test event always has type: webhook.test and empty data.attributes (see the webhookDelivery callback of POST /v1/webhooks). A test event is signed, and carries a bearer token when an auth profile is bound, exactly like a real event. It does not change the subscription status.

Request

Responses

202

Accepted. The operation (data.id) tracks the test request.

400

data.attributes.event_type is missing, or the Idempotency-Key header is missing.

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 request has an invalid shape or an unsupported event type.

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.