How it works
Contacts
Your users, keyed by your own user ID. A name, email, phone number and any attributes you like, such as a plan or a verification status.
Events
Things that happened to a contact, like “Transfer failed”. On the customer’s timeline, and as a card in any chat with them from the last 24 hours.
Actions
Buttons beside each chat, like “Retry transfer”, that call your server.
identify() links them to their website chats.
Two ways in
From your server
The REST API. Agents can trust what it sends.
From your website
The chat widget. Identity is signed by your server; everything else is shown as unverified.
Before you start
- The Context API is on the Pro plan and above. The website chat and bookings don’t need it.
- A workspace owner creates an API key in Settings → Developers. API keys and secrets explains each one.
- Just want live chat? The install guide is all you need.

