Deprecations

The API has no version in its paths, and code that works today keeps working. An operation, a parameter or a field is never renamed or taken away, never changes what it means, and never answers with another status code or error code, without the notice below. Webhook deliveries are held to the same rule: their event types, the fields of their data and their signature.

These changes come without notice, so write code that expects them:

• —New operations, and new optional parameters on the ones there are.
• —New fields in a response or in the data of a webhook.
• —New values for a field that holds a state, a kind or a reason, and new error codes.
• —New webhook events. An endpoint that names its eventTypes receives only those.
• —The wording of message in an error. Read code, which does not change.
• —The order of the fields in an object, and of the items in a list that promises no order.

When an operation, a parameter, a field or an event has to go, or has to change in a way that would break code, it is deprecated first:

1. 1It is announced on the changelog, with what to use instead.
2. 2It is marked as deprecated in the OpenAPI document and in the reference.
3. 3The owner of every workspace whose keys or connected apps used it in the 90 days before is told by email.
4. 4It keeps working for at least six months after the announcement. Its removal is on the changelog too.

The SDKs and the command line tool follow the API. A method that calls a deprecated operation is marked as deprecated in the next release, and it is removed only after the operation is.

A change that closes a security hole, stops abuse or is required by law can take effect sooner, at once if it has to. It is still on the changelog, and the owners whose calls it affects are told by email.

This policy was published in October 2026 and covers every change announced after it. The breaking changes listed under October 2026 on the changelog came before it.