Rootline versions
When modifications are made to the API that are not compatible with previous versions, we release a new version through a custom http header where the value is the date of the new API release. This way you will not be exposed to backwards incompatible changes until you are ready to switch to a newer version. We keep the amount of backwards incompatible changes relatively small from version to version to allow for maintainable upgrades. To learn more about changes between our versions, please consult our Change logs.
Enforcement
With every API call we ask that you send the Rootline-Version
in the http header of the API request. Our latest version is 2024-04-23
. Fill out the version header key and value like shown here:
key: Rootline-Version
value: 2024-04-23
Failing to provide the Rootline-Version
in your header, will lead to a 422
http error, and in the response body we will let you know that the error_code
is missing_header
where the missing field
is Rootline-Version
.
Webhook events will be sent according to the API version that you configured for your endpoints.