Support API
Put Gauge's live chat, tickets and callbacks inside your own web or mobile app, signed in as your own users.
The Support API lets a software company give its own customers support inside its product, answered by its team in Gauge. Your backend keeps Gauge in step with your users; your app opens the chat already signed in; Gauge sends events back to your server.
It lives on /v1/support and uses the same API keys with the support:read and
support:rw scopes. A key can be pinned to one App (a support project), and a test key reaches
only the sandbox App.
Start here
Quick start
Provision users, embed the widget or portal, and receive verified webhooks, in about 15 minutes.
Web app
Chat for signed-in users in your website or web app.
Mobile app (WebView)
Chat inside your iOS, Android, Flutter or React Native app.
API only
Your backend provisions users and mints sign-in links. No widget.
Per framework: Next.js, Express, Django, Laravel, Rails and Go.
Guides
| Guide | |
|---|---|
| Signed integration tokens | Tell Gauge who your user is and which Integration they are on |
| Keeping users in sync | Provision, update, deactivate and grant access |
| Callbacks | "Request a callback" from the portal, widget or your backend |
| Native Help & Support screens | Build your app's own support screens on Gauge data |
| Native apps | Live chat in a WebView, and push on reply |
| WebView recipes | Copy-paste screens for React Native, iOS and Android |
| The API core (S1) | The full route-by-route reference for the support embed |
The events these send are in the event catalogue.