The Gauge API
Send and receive customer messages on WhatsApp, email and web chat, keep contacts in sync, and get every event at your own endpoint.
Gauge is a revenue inbox: a business's WhatsApp, Instagram, Messenger, email, web chat and phone calls land in one priority-sorted queue. The Gauge API gives your code the same access a member of the team has in the console. It can see the connected channels, send and read messages, keep contacts in step with your own system, and receive events the moment they happen.
Quickstart
Create a key, make your first call, send a WhatsApp message and receive replies by webhook.
Authentication and keys
Bearer keys, scopes, live and test environments, IP allowlists, expiry and rotation.
API reference
Every /v2 endpoint and webhook event, generated from the API's own OpenAPI document.
Webhooks
The event catalogue, signature verification, retries, replay and inbound message forwarding.
What you can build
- Reply from your own product. Read a conversation and answer it from your CRM, booking system or back office, on the channel the customer used.
- Forward inbound messages. Receive every new customer message at your endpoint, signed, and route it wherever it needs to go.
- Keep contacts in sync. Create and update contacts from your system of record, so the team sees the same customer you do.
- Embed support in your app. The Support API puts Gauge's chat, tickets and callbacks inside your own web or mobile app, signed in as your user.
What is available today
The API is versioned by path. /v2 is the current version and is being built out area by area.
This table is the honest state of each area; every page in these docs carries the same marks.
| Area | Status | Where |
|---|---|---|
Who a key is (GET /v2/me) | Live | Reference |
| Connections and their capabilities | Live | Channels |
| Webhooks: signed delivery, retries, replay, test events | Live | Webhooks |
Support API (/v1/support): customers, chat, tickets, callbacks | Live | Support API |
| Contacts, conversations, messages, media, templates | Live | Messaging |
Message events (message.received and friends) | Live | Events |
| SMS and voice | Coming soon | Channels |
Coming soon means the area is planned and not yet available. Watch the changelog.
The basics
| Base URL | https://app.gauge.chat/backend |
| Version | /v2 in the path, plus an optional dated Gauge-Version header (Versioning) |
| Authentication | Authorization: Bearer <key> (Authentication) |
| Format | JSON in, JSON out, UTF-8 |
| Errors | One envelope, { "error": { "code", "message", "requestId" } } (Errors) |
| Plans | Growth and Scale. The API is not included on Free (Plans) |
There is no Gauge SDK yet. Every example in these docs is plain HTTP in curl, Node (fetch) and
Python (requests), so it works with whatever HTTP client you already use. An official Node SDK,
@silquetech/gauge-sdk, will follow the v2 endpoints.
Using an AI assistant?
These docs are published for AI tools as well: /llms.txt indexes every page,
/llms-full.txt has all of it in one file, and every page has a Copy page
button. See Use Gauge with AI tools.