Skip to main content
Version: 8.2

Public API

Camunda Platform 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates.

Backwards compatibility for public API

Camunda Platform 8 versioning scheme follows the MAJOR.MINOR.PATCH pattern put forward by semantic versioning. Camunda Platform 8 will maintain public API backwards compatibility for MINOR version updates.

Example: Update from version 1.0.x to 1.1.y will not break the public API.

To learn more about our release cycle, refer to our release policy.

Definition of public API

Currently, both Zeebe API and Tasklist API are officially supported APIs:

All non-implementation Java packages (package name does not contain impl) of the following Maven modules.

  • io.camunda:zeebe-client-java

Other APIs and clients

Currently, we cannot guarantee backwards compatibility with other APIs and clients, though we do work to offer backwards compatibility to the best of our ability.