Versioning & changelog

Versioning policy#

The major version is in the path: /api/v1/…. Within v1 we only make additive changes:

• new endpoints and new optional request fields;
• new response fields;
• new enum values;
• new webhook event types.

So your client must ignore unknown response fields, handle unknown enum values gracefully, and answer 2xx to unknown event types.

A breaking change ships as /v2. v1 then stays available for at least 12 months. The retirement date is announced in this changelog, emailed to every technical contact, and sent on v1 responses as Deprecation and Sunset headers.

Changelog#