Versioning
API Versioning
When updates are incompatible with previous versions (backwards-incompatible), a new, dated version of the API is released. The current version is: 2024-04-04
API versions are specified using the Method-Version
header, and while you may continue using older versions, you will not have access to the latest features.
You can upgrade to the latest or a specific version through the Dashboard, or by specifying the version in request headers. Note that once upgraded manually, it’s not possible to revert to older versions.
Backwards Compatible Changes
Method defines the following changes as backwards-compatible:
- Adding new API resources.
- Adding new properties to existing API responses.
- Adding new values to enum fields in API responses.
- Adding new properties to webhook payloads.
- Changes to the length, format, or content of human-readable strings (error messages, etc.).
- Adding new event types.
- Make sure that your webhook logic can gracefully handle unfamiliar event types.
Library Versioning
For Method Libraries, the version is locked to the dated version of the API. For example, method-node v0.x.x
is locked to 2020-12-06
, while method-node v1.x.x
is locked to 2024-04-04
and onwards.
For detailed version histories, refer to our Changelog.