Docs Overview

How it fits into an application

Apps, users, API keys, user tokens and webhooks: what to know before writing any code.

Documentation
   your front end  ───── user token ─────►  ┌─────────┐
   (web, mobile)   ◄──── REST + WebSocket ─ │         │
                                            │  Bonga  │ ── Oracle
   your server     ───── API key ────────►  │         │ ── Redis
                   ◄──── webhooks ───────── └─────────┘
  • An app is a tenant: one application that uses this server. Everything belongs to exactly one app.
  • A user is known to Bonga by the id your application already has for them. You never store a user id of Bonga's, and none is ever shown. Users are not registered: the first time your server mentions one (asks for a token, adds them to a conversation), they exist.
  • Your server talks to Bonga with the app's API key and may do everything within the app.
  • Your front end talks to Bonga directly with a user token your server fetched for it, and may do what that user may: only the conversations they are in, by the rules of their role.
  • Bonga tells your server what happens through webhooks, which is how you send push notifications to people who are not connected.