Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
How the API is versioned, and which changes can reach you without a new version.
/v1.
v1 without notice. Build your integration so these changes don’t break it:
| Change | What your code should do |
|---|---|
| A new endpoint | Nothing. |
| A new field in a response or an event | Ignore fields you don’t use. Don’t fail on fields you don’t recognise. |
| A new event type | Ignore types you don’t handle. |
A new value in a list of values, such as an order state, a reject_reason or an error code | Handle an unknown value with a safe default. Don’t generate clients with closed enums that reject new values. |
| A new optional request field | Nothing. |
New wording in message or reason | Nothing. These are for people to read, so never match on them. |
code for an outcome./v2, and we tell you in advance. We record changes in the changelog.