Skip to main content
Version: 8.9

Zeebe API (gRPC)

Use the Zeebe API (gRPC) to manage and interact with Camunda 8 Orchestration Clusters.

About​

You can use the gRPC high-performance, cross-platform remote procedure call (RPC) framework to communicate with the Orchestration Cluster.

Zeebe clients use gRPC to communicate with the cluster. For example, you can use this API to activate jobs, cancel and create process instances, and more.

Why use gRPC?​

Using this API may be beneficial if your use-case requires low-latency or high-throughput communication.

Benefits of gRPC include:

  • Low-latency, high-throughput communication
  • Bidirectional streaming for efficient microservices integration
  • Ideal for scalable, event-driven process automation

Key capabilities​

  • Activate jobs
  • Create and cancel process instances
  • Manage workflows and more

See Zeebe API RPCs for all available operations. Additionally, review technical error handling for a closer look at business logic errors, or Postman to experiment with the API.

Authentication​

Authentication for the Zeebe API (gRPC) depends on your environment and how you deploy Camunda 8. You can find more details in the Authentication guide.