Owners create API keys in Settings → API, each limited to the scopes it needs. Full reference: Developers and the OpenAPI description.
- REST API — conversations, messages, contacts, articles and reports.
- Webhooks — signed events when conversations start, messages arrive, chats are resolved or rated, and deadlines are missed. Retried for about two days, and replayable.
- TypeScript client — one typed file, with webhook signature checks.
- Slack — new and waiting conversations, ratings and missed deadlines in a channel (Settings → Integrations).
- Account connector — show the customer's account from your own panel, shop or CRM beside every conversation, and let your team act on it, with every action recorded.
Creating an API key or a webhook is recorded in the audit log and emailed to the other owners.
Getting started
- Open Settings → API as an owner and create a key with the narrowest scope that works.
- Call the REST API with the key as a bearer token. The full reference is on the developers page and in the OpenAPI description.
- To receive events, add a webhook and verify its signature on every request.
Keep keys out of source code and browser pages. Rotate a key if you suspect it leaked: create a new one, switch your system over, then delete the old one.
Related guides
Send events to chat tools with Slack and the account connector, add ready-made tools from plugins, and keep keys safe with account security.