Api version system

As part of our ongoing efforts to improve Devengo services and make our systems more consistent and useful, we are introducing a new API version system.

Why the change?

We understand that having a clear and consistent API version system is crucial for our customers' integrations. This system will allow us to manage the API versioning in a more efficient and consistent way.

What does this mean for you?

We've stablished 2025-12 version as the first version of the API version system. This change have no impact on your existing integrations since all api keys currently created are using this version. Following published versions will be available for new api keys and webhooks. Each version has a specific date of publication and an expected date of deprecation. When a version is deprecated, it will no longer be available for new api keys and webhooks.

How to migrate to the new API version system?

You don't need to do anything but start using the new API version system and stop using the JWT authorization system which will be deprecated soon. The new API version system is already in place and you can use it without any changes. Check API Versioning documentation to get more information about how to use it.

Key features of this enhancement include:

1. API Versioning: Set up 2025-12 version as default version for API Keys authentication system and deprecate JWT authorization system.
2. Webhooks Versioning: Set up 2025-12 version as default version for webhooks system.

When will be the new changes come into effect?

These changes will be available starting January 1, 2026.

What if I have any questions?

If you have any questions, or need help integrating API Versioning functionality in your systems, you can check our documentation about API Versioning or contact us at [email protected].