Skip to main content
Version: latest

Working with APIs & Clients

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

APIs and interacting with other components#

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

Other components in Camunda Cloud, 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 Cloud's provided public API.
  • Cloud Console API clients (REST) - Enables you to programmatically create and manage clusters, and interact with Camunda Cloud programmatically without using the Camunda Cloud UI.
  • Zeebe API - Zeebe clients use gRPC to communicate with the cluster.

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 Cloud via gRPC, a high-performance, open-source, and universal RPC protocol.

Camunda Cloud provides several offical 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.

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

Official clients#

Community clients#

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