Versioning
The current API version is v1 and is reflected in the URL path (/v1/...).
Backward-compatible changes
Section titled “Backward-compatible changes”The following are not considered breaking and may be added at any time without bumping the version:
- New endpoints
- New optional request parameters
- New fields in response objects
- New event types
- New enum values (clients should treat unknown enum values as “unknown” rather than erroring)
Breaking changes
Section titled “Breaking changes”Breaking changes (removing fields, changing types, renaming) are introduced under a new version (/v2, /v3, …). Old versions are supported for at least 12 months after a successor is announced.
Subscribe to the Changelog for announcements.