Changelog
How the API changes, what counts as a breaking change, and where the record will live.
What can change without notice
- New endpoints, and new optional fields on an existing request.
- New fields on a response — write a client that ignores what it does not recognise.
- New event types, including inside a family you already subscribe to with
credential.*. - New enum values on a field that is already documented as a set, such as a new channel state.
What does not change inside `/v1`
- A field is not removed, renamed, or given a new meaning.
- An event type is not renamed. They are part of the public contract, and renaming one breaks a customer's integration.
- An error
codestays stable, which is why your software should branch oncoderather than onmessage.
Anything that would break one of those becomes a new version of the API, not a quiet edit to this one.