API reference
Every /v2 endpoint and webhook event, generated from the API's own OpenAPI document.
This reference is generated. Every page under it is built from the OpenAPI 3.1 document the API
itself serves at GET /v2/openapi.json, at the same commit. It lists exactly what is live, with
the scope each endpoint needs, its parameters, its responses and samples in curl, Node and Python.
- Machine-readable:
/openapi/v2.json(orhttps://app.gauge.chat/backend/v2/openapi.json). Feed it to a code generator or an API client. - Server:
https://app.gauge.chat/backend. - Authentication:
Authorization: Bearer <key>on every operation (Authentication). - Scopes: each operation shows the scope it needs as
x-scopes;x-idempotent: truemarks operations that need anIdempotency-Key. - Errors: every operation answers errors in the shared
Errorenvelope (Errors).
Every live /v2 endpoint is listed here, including the messaging and webhook-management
operations; the guides (Messaging, Webhooks) explain how to use them.
Version 1
/v1 is frozen: it keeps working and gets security fixes only. The Support API lives
on /v1/support and is documented in its own section; its OpenAPI document is served by the API at
GET /openapi.json.
Forward inbound messages
Receive every customer message from WhatsApp, email, web chat and Meta channels at your own endpoint, signed and in real time.
Who this key is GET
The key, the member it acts as, the workspace and plan, its scopes, environment and the rate-limit budget left. Any valid key may call it.