API Changes
APIs change over time. This section describes how we manage those changes.
New endpoints
We may add new endpoints at any time. We will document new endpoints when they become available.
Non-breaking changes
We may introduce non-breaking changes without notice, including:
- Adding optional request properties
- Adding response properties
- Adding new event types
Your integration should ignore unknown JSON properties and handle unrecognised event types gracefully.
Breaking changes
We classify a change as breaking if it may require updates to an existing integration. Examples include:
- Adding a mandatory request property
- Introducing a new response or status value that affects integration logic
Where possible, we will contact affected integrators directly and provide at least three months’ notice before a breaking change takes effect. In cases driven by regulatory or external requirements, the notice period may be shorter.
Versioning
The API is currently unversioned. We may introduce versioning in future if substantial API changes are required.
Updated 16 days ago