APIs & tools

Camunda 8 APIs and official clients and SDKs.

Use Camunda 8 APIs and clients to build, automate, and monitor your applications. Use the official Camunda clients and SDKs (Java, Spring, and Node.js) to simplify API usage and speed up development.

Get started with the Camunda Java Client

Upgrade to Camunda 8.9

• Existing customer? Upgrade your APIs & tools to 8.9 using the APIs & tools migration guide.
• See what's new in Camunda 8.9, release announcements, and release notes.

APIs

Use the following APIs for Camunda 8 integration and automation:

Orchestration Cluster API

Main API for process automation, orchestration, and task management.

REST

Orchestration Cluster MCP Server

Exposes selected Orchestration Cluster APIs as MCP tools for AI agents and LLM-powered applications.

MCP

Administration API (SaaS)

Manage Camunda clusters and API clients in SaaS.

REST

Administration API (Self-Managed)

Get cluster data including installed apps and usage metrics.

REST

Optimize API

Process analytics, dashboards, and reporting data.

REST

Web Modeler API

Integrate with Web Modeler for modeling automation.

REST

Zeebe API (gRPC)

Advanced integrations and high-performance use cases.

gRPC

API clients

Camunda provides the following official clients to simplify API usage and speed up development:

Camunda Java Client

The recommended way to build Orchestration Cluster integrations and job workers in Java.

Camunda Spring Boot Starter

Build Spring Boot applications to connect to the Orchestration Cluster to build job workers.

TypeScript SDK

Build Camunda 8 applications using the Camunda TypeScript SDK.

c8ctl CLI

Inspect clusters, deploy resources, and manage processes from the terminal.

Python SDK

Build Camunda 8 applications using the Camunda Python SDK.

C# SDK

Technical preview of the C# client SDK for the Camunda 8 Orchestration Cluster REST API.

community clients

In addition to the core Camunda-maintained clients, there are a number of community-maintained component clients.

Client and API compatibility

Camunda clients and SDKs are forward-compatible with the Orchestration Cluster, meaning you can upgrade the cluster first and clients after. The Orchestration Cluster REST API is backward-compatible, ensuring no breaking changes to existing endpoints across versions.

Client and API compatibility guarantees

Testing

Use Camunda Process Test to test your process definitions and automations with a dedicated testing framework.

Camunda Process Test

Upgrade to Camunda 8.9

If you are migrating from Camunda 7 or from v1 component REST APIs, see the migration guide for guidance.

Camunda 8.9 APIs & tools migration guide

Need more help? Click Ask AI to open our AI-powered smart docs. Using developer docs, forum posts, and product blogs from the last year, responses are generated by combining various sources to formulate the best possible answer to your question.