CueFrame
API reference

OpenAPI 3.1 document for the v1 API

Returns the generated OpenAPI 3.1 document. Unauthenticated so SDK tooling (Orval, Postman, redocly) can fetch without a key. Cacheable for 5 minutes.

GET
/openapi.json

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/openapi.json"
{}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

Fire a webhook.test delivery POST

Required permission: webhooks:write

Shallow + deep health check GET

Shallow (default) returns 200 with a minimal liveness payload for load balancers. Append `?deep=1` to exercise component bindings (rate-limiter). Unauthenticated.