Skip to main content
Version: 8.1

Working with APIs & Clients

This section steps through a variety of offered APIs and clients for integration.

note

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.

APIs and interacting with other components

The clients mentioned below interact with Zeebe, the workflow engine integrated into Camunda Platform 8.

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.

Additional APIs

  • Public API - Camunda Platform 8's provided public API.
  • Cloud Console API clients (REST) - Enables you to programmatically create and manage clusters, and interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 UI.
  • Zeebe API - Zeebe clients use gRPC to communicate with the cluster.
note

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

Clients

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.

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 (e.g. thread handling for job workers) on top of the core API.

Official clients

Community clients

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

You can browse other community extensions and the most up-to-date list of community clients here.

Finally, it is possible to build your own client if none of the other options are suitable.