Changelog
This page records changes to the Smartbtn public API and webhooks over time. It is empty besides the initial release below -- that's expected for a v1 that just shipped, not a placeholder that was forgotten.
v1 -- initial public release -- 2026-07-10
First public release of /api/v1: bearer-token authentication with
per-token scopes, chats/messages/contacts/agents/tags/files/stats/channels
resources, outbound webhook subscriptions, the async external-AI-reply endpoint,
and the day-one Jivo-compat routes under /compat/jivo. See
Endpoints and
Webhooks for the full reference
of what's live today, including which webhook event types are still
canary-disabled pending rollout.
Versioning policy
The API version is in the path (/v1, later /v2), not in
a header or query parameter. Going forward:
- Additive changes stay in
v1. A new field on an existing response, a new optional request parameter, a new endpoint, or a new webhook event type is not a breaking change -- clients are expected to ignore fields/events they don't recognize. These land as new entries on this page under av1heading, without a version bump. - Breaking changes get a new version. Renaming or removing a field, changing a field's type or meaning, renaming or removing a webhook event, or any change that could break a client that only knows the previous shape ships under
/v2instead, with a deprecation window for/v1announced here before it's turned off./v1keeps working unchanged until that window ends. - Webhook event names are frozen independently of the path version. Once an event type is enabled for a customer to subscribe to, its name and meaning do not change without a major version bump -- a name change would silently break every existing subscription filtering on that string.
- The signature header version (
sha256=v1:...) is independent of the API path version. It changes only if the signing scheme itself changes (e.g. a future move to a different digest algorithm), not when/v1becomes/v2.
Future breaking changes -- and the additive changes that don't warrant a version bump -- get their own dated entry above this policy section as they ship.