#Changelog
Status: Available. The log has been kept since the first publication of the documentation.
Purpose: record changes to the public API contract and the documentation. Any breaking change and any deprecation is announced here at least 90 days before it takes effect (the Deprecation and Sunset headers duplicate the entry in API responses; see Conventions).
#Versioning policy
| Rule | Description |
|---|---|
| Version in the address | /api/public/v1 |
| Within a version | Only additive changes (new endpoints, optional parameters, response fields) |
| Breaking change | Ships as a new version (v2); v1 keeps working throughout the deprecation period |
| Notice period | At least 90 days before shutdown |
| How to find out | An entry here + the Deprecation and Sunset headers in responses |
| Page statuses | "Available", "Beta", "Planned": see the README |
#Entry format
Each entry contains the date, the affected area, and the type of change: added, changed, deprecated, removed, fixed, security.
#2026-10-11 — server API: reading, wallet, webhooks v2
API
- Added:
GET /me,GET /wallet; webhooks v2 (subscriptions, signing, retries, delivery log). - Added: reading conversations and messages (
GET /conversations,GET /conversations/{id},GET /conversations/{id}/messages). - Added: reading analytics (
/analytics/timeseries,/analytics/traffic-sources,/analytics/funnel,/analytics/visibility) and dashboards (/dashboards/overview,/dashboards/pulse). - Added: reading leads (
GET /leads,GET /leads/{id}), articles (GET /articles,GET /articles/{id}), and strategist reports, topics, and actions. - Still "Planned": writing (replies in conversations, editing leads and articles, decisions on topics and actions), events and offline conversions, article generation, the strategist chat, the status map, the widget JS API v2, test keys and the sandbox,
GET /disclosures.
Documentation
- Changed: page statuses moved from "Planned" to "Available" for the released endpoints; response fields were checked against the implementation.
- The "Available" status takes effect with the deployment to a cell and the application of its migrations; a read that depends on a migration answers
503until then.
#2026-10-11 — first edition of the documentation
Documentation
- Added: the documentation structure and the cross-cutting sections: introduction, quickstart, authentication, cells and data, conventions, webhooks, changelog, glossary.
- Added: a description of the existing client interfaces: the chat widget, the Chat API, the loader, the JS tracker, the server beacon and the CMS modules, and the article publisher through the connector (status "Available"; details are in the
chat/,analytics/, andarticles/sections). - Added: a description of the server API authenticated by a secret key (status "Planned"): integrations and keys, scopes, conversations and the AI seller, leads and the external CRM, analytics and dashboards, articles, the strategist, webhooks v2.
API
The v1 server API has not been released yet: there have been no contract changes. Until the OpenAPI specification is published, the response examples are illustrative.
#Planned platform changes that affect integrators
The entries below are warnings about what will change, not a log of completed changes.
| What | Type | Who it affects |
|---|---|---|
Outgoing webhooks of the previous version (v1) are replaced by webhooks v2: the envelope {id, type, api_version, created_at, livemode, data}, the Sapport-Signature signature, retries, a delivery log, secret rotation. The operator handoff event handoff.requested is replaced by conversation.handoff_requested | changed | Anyone who receives webhooks of the previous version. The customer message text (content) is removed from the previous version's payload |
Wallet and exchange suspension: GET /wallet, the wallet block in GET /me (state, exchange, topup_url), the 402 wallet_suspended code on all routes when the balance is negative or the wallet is blocked, deferred webhook delivery (details) | added | All server API clients |
A single error format application/problem+json with errors[] by JSON Pointer | added | All server API clients |
Cursor pagination, Idempotency-Key, RateLimit-* headers, asynchronous operations (operation) | added | All server API clients |
| Test keys and the sandbox | added | Anyone who wants to test an integration without production data |
#How to follow changes
- Subscribe to dashboard notifications: the tenant owner receives messages about key issuance, rotation, and imminent expiry; the
api_key.expiringevent arrives 30 and 7 days before expiry. - Read the
DeprecationandSunsetheaders in API responses: automate logging them on your side. - Check this log periodically.