Sapport API and integrations
Connect the AI seller chat, analytics, CRM, articles and the strategist to your site and systems. Guides, the method reference and examples in one place.
Sections
Getting started
Introduction, quickstart, keys, cells and personal data, conventions, webhooks.
Chats and AI seller
Chat widget, JS API, server-side conversations and the AI seller own channel.
Analytics and dashboards
Loader, tracker, events, offline conversions, reading analytics and dashboards.
CRM and leads
CRM modes, leads API, scoring, agent actions, statuses and PII transfer.
Articles
Article generation and publishing, site modules, articles API.
Strategist
Strategist reports, topics and actions, chat with the strategist.
API reference
Every method from OpenAPI grouped by tag: parameters, request and response examples, error codes.
How to start
- 1. Get a key
Keys are issued in the API settings of your account and work only in their own cell. - 2. Make a first request
An Authorization: Bearer header and any read method from the reference. - 3. Subscribe to events
Webhooks report leads and conversations without polling.
Statuses and flags
Available works in production cellsPlanned being designed, the contract is the target onePaid Charges the tenant walletPII Returns or accepts personal data: a separate scope is required
Search methods and sections: press Ctrl+K (Cmd+K on Mac) or the slash key.