Skip to main content

Versioning policy

The API surface lives under /api/v1/. v1 is stable:

We may (non-breaking — your parser must tolerate)​

  • Add fields to responses and webhook payloads
  • Add new event types (subscribe-only — never sent unless you opt in, beyond the documented default set)
  • Add new endpoints and optional request fields

We will never (in v1)​

  • Remove or rename an existing field
  • Change a field's type or semantics
  • Change the signing scheme, envelope shape, or error contract

Breaking changes ship as /api/v2/… with at least 6 months of parallel v1 support and direct notice to your technical contact.

The machine-readable spec at /api-reference (also served by the API itself) is regenerated from the running service — it cannot drift from behaviour.