Skip to main content
Version: Next

Working with APIs & tools

This section steps through two concepts for integration:

  • Control your Camunda Platform 8 process automation by deploying processes, starting process instances, activating jobs, and more using supplemental and community-maintained Zeebe client libraries.
  • Interact with the Camunda Platform 8 ecosystem by learning about Camunda Components and their APIs to communicate with your cluster, search, get and change data, create Cloud API clients, and more.

You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, purchase the Camunda Platform Enterprise Edition. Read more in our licensing documentation.

Deploy processes, start process instances, and more using Zeebe client libraries

Clients allow applications to do the following:

  • Deploy processes.
  • Start and cancel process instances.
  • Activate jobs, work on those jobs, and subsequently complete or fail jobs.
  • Publish messages.
  • Update process instance variables and resolve incidents.

The official clients mentioned below interact with Zeebe, the workflow engine integrated into Camunda Platform 8. All clients require setting up client credentials to authenticate. Clients connect to Camunda Platform 8 via gRPC, a high-performance, open source, and universal RPC protocol.

Camunda Platform 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (for example, thread handling for job workers) on top of the core API.

Official Zeebe clients

Official clients have been developed and tested by Camunda. They also add convenience functions (e.g. thread handling for job workers) on top of the core API.


Other components in Camunda Platform 8, such as Tasklist API (GraphQL), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks.

Community clients

Community clients supplement the official clients. These clients have not been tested by Camunda.

It is also possible to build your own client You can browse other community extensions and the most up-to-date list of community clients here.

Learn about Camunda Components and their APIs

Camunda Platform 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs.

Architecture diagram for Camunda Platform including all the components for SaaS

API Reference


Additionally, visit our documentation on Operate and Tasklist usage metric APIs.


Camunda maintains a set of collections and APIs on Postman to help learn and use the available APIs.

Watch and fork your favorite collections and APIs on the Camunda Team.


Collections and APIs are manually updated and not all API functionality may be available. For the most up-to-date API functionality, see the API reference docs.

Community SDKs

In addition to APIs and clients, the Camunda Developer Experience team is looking for feedback on popular community clients turned SDKs. While these are currently on the Camunda Community Hub, we are actively iterating and evaluating feedback to fully support them.