Versioning & stability
Versioning & stability
Pre-release v1, published 2026-09-14. This page commits to the shape of the API, not to a
date. We will build exactly what is documented here. The shape can still change until
2026-10-14; after that, changes follow Versioning and stability.
The banner comes off one page at a time as each route goes live. While it is here, build against the contract and assume the route is not callable yet.
The URL version
v1 changes only on a breaking change. We do not bump it for additions.
What is not breaking
Added fields are not a breaking change. Your integration must ignore fields it does not recognise. This rule is what lets us improve the API without forcing you to re-integrate. It is also the most common cause of a partner integration breaking on an upgrade that broke nobody else.
Write your parsers so a new enum value or event type does not throw. Log it and move on.
Webhook payload versioning
Every event carries schema_version, in semver:
Fields are added with a minor bump. Nothing is removed or repurposed without a major bump and advance notice.
The pre-release banner
While a page carries the pre-release banner, its routes are not yet callable. The banner is a commitment to the shape, not to a date.
The banner is removed page by page as each route goes live, never globally and never early. A page without a banner is a page whose routes you can call today.
Getting notice
Breaking changes and deprecations are announced to your account manager before they ship. If your contact details change, tell us. This is the channel we use.