Workflow automation · API / SDK

Camunda Orchestration API

Camunda

Integrate process automation, tasks and orchestration through public interfaces.

Official documentation Download development spec

CAMUNDA 8 / DEVELOPER FIELD GUIDE

Choose an interface. Define a verifiable result.

Company or project context, ten technical entry points and a practical analysis of every reference.

2026-10-08 · Integration not tested

Company / project overview

Original summary of official company or project statements; use the source for the full original page.

Camunda 8 · About
Company focus	Camunda develops process orchestration across people, systems and devices.
Method	Its company overview emphasizes process design, orchestration and open standards.
Guide boundary	This guide follows Camunda 8 APIs; older Camunda 7 integrations need a separate migration decision.

Complete official About page ↗

About reference — TA analysis
Audience	Buyers, partners and product owners shortlisting an AI provider.
Our assessment	Use positioning and company history for initial fit. Obtain project-specific deployment, support and commercial terms separately.

Official sources reviewed. No provider API or inference was run; results are illustrative internal contracts.

Top 10 technical entry points

Ten documented technical entry points selected for implementation decisions, not ten independent SDKs or an official ranking.

Choose by the work you need to complete
Interface	Purpose and audience
01 · Orchestration Cluster REST APIAPI / SDK / developer guide	Integrate orchestration and task-management operations.API developers
02 · Job workersAPI / SDK / developer guide	Execute service tasks using worker code.Service integration teams
03 · MessagesAPI / SDK / developer guide	Correlate external messages with waiting processes.Event integration teams
04 · VariablesAPI / SDK / developer guide	Pass data through process scopes.Process designers
05 · IncidentsAPI / SDK / developer guide	Inspect blocked execution and resolve causes.Operations teams
06 · Process-instance migrationAPI / SDK / developer guide	Move running instances to compatible definitions.Release managers
07 · Process-instance modificationAPI / SDK / developer guide	Adjust active process execution deliberately.Recovery operators
08 · Create process instanceAPI / SDK / developer guide	Start a deployed process definition.Application developers
09 · Complete jobAPI / SDK / developer guide	Report successful job execution.Worker developers
10 · Evaluate decisionAPI / SDK / developer guide	Evaluate a deployed decision definition.Business-rule teams

Reference analysis

Capabilities summarize official documentation. Constraints and proposed tests are our engineering assessment.

API / SDK / developer guide

Orchestration Cluster REST API

Orchestration Cluster REST API · TA
Target audience	API developers
Documented capability	Integrate orchestration and task-management operations.
Input → output	Authenticated REST request → operation response.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Use the API generation matching the cluster; Camunda 7 endpoints differ.
Our suggested validation	Check authentication, permissions and error mapping.

Official reference · Orchestration Cluster REST API ↗

API / SDK / developer guide

Job workers

Job workers · TA
Target audience	Service integration teams
Documented capability	Execute service tasks using worker code.
Input → output	Activated job → completion or failure.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Job retries require idempotent external effects.
Our suggested validation	Test duplicate activation and worker crash recovery.

Official reference · Job workers ↗

API / SDK / developer guide

Messages

Messages · TA
Target audience	Event integration teams
Documented capability	Correlate external messages with waiting processes.
Input → output	Message name and correlation key → matched process.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	No matching subscription differs from successful business completion.
Our suggested validation	Test correlation keys, expiry and duplicate messages.

Official reference · Messages ↗

API / SDK / developer guide

Variables

Variables · TA
Target audience	Process designers
Documented capability	Pass data through process scopes.
Input → output	Variables and mappings → scoped process data.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Scope and mapping can overwrite or hide values.
Our suggested validation	Check schema and variable visibility at each step.

Official reference · Variables ↗

API / SDK / developer guide

Incidents

Incidents · TA
Target audience	Operations teams
Documented capability	Inspect blocked execution and resolve causes.
Input → output	Execution problem → incident requiring action.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Incident resolution is not equivalent to the process finishing.
Our suggested validation	Verify resumed state and ultimate business result.

Official reference · Incidents ↗

API / SDK / developer guide

Process-instance migration

Process-instance migration · TA
Target audience	Release managers
Documented capability	Move running instances to compatible definitions.
Input → output	Migration mapping → instance on target definition.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Mappings and active elements impose restrictions.
Our suggested validation	Dry-review mappings and test representative active states.

Official reference · Process-instance migration ↗

API / SDK / developer guide

Process-instance modification

Process-instance modification · TA
Target audience	Recovery operators
Documented capability	Adjust active process execution deliberately.
Input → output	Modification instructions → changed active elements.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Skipping steps can bypass required business work.
Our suggested validation	Authorize recovery action and validate resulting state.

Official reference · Process-instance modification ↗

API / SDK / developer guide

Create process instance

Create process instance · TA
Target audience	Application developers
Documented capability	Start a deployed process definition.
Input → output	Definition selection and variables → instance identifier.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Creation acknowledgement is not completion.
Our suggested validation	Track instance through terminal state.

Official reference · Create process instance ↗

API / SDK / developer guide

Complete job

Complete job · TA
Target audience	Worker developers
Documented capability	Report successful job execution.
Input → output	Job key and variables → accepted completion.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Complete only after required external work succeeds.
Our suggested validation	Test stale keys and failed completion requests.

Official reference · Complete job ↗

API / SDK / developer guide

Evaluate decision

Evaluate decision · TA
Target audience	Business-rule teams
Documented capability	Evaluate a deployed decision definition.
Input → output	Decision identifier and inputs → decision output.
Execution environment	Camunda 8 cluster with authorized client and compatible deployed definitions
Our decision constraint	Rule version and input types affect results.
Our suggested validation	Check boundary values and no-matching-rule cases.

Official reference · Evaluate decision ↗

Official documentation

Official documentation · Supporting reference analysis
TA	Developers and technical product owners
Our validation advice	Pin the release and follow the target-specific support requirements before implementation.

Official reference · Official documentation ↗

04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE

Expected results before implementation

Illustrative process tracking contract, not raw Camunda JSON. No process, job or decision API was called.

Illustrative contract · no API call or model execution · not measured provider output

Review process completed

Expected behavior — illustrative, not executed
Input	Valid RFQ variables and deployed review definition.
Expected result	ok after all required human/service steps finish.
Acceptance	Check business decision, definition version and terminal state.

Waiting for human task

Expected behavior — illustrative, not executed
Input	Instance reaches required approval task.
Expected result	pending with task/instance references.
Acceptance	Do not infer approval from successful creation.

No matching decision rule

Expected behavior — illustrative, not executed
Input	Valid inputs outside the configured business rules.
Expected result	Explicit no-match result according to decision contract.
Acceptance	Route for review rather than inventing approval.

Worker creates incident

Expected behavior — illustrative, not executed
Input	Required service task fails beyond retry allowance.
Expected result	blocked/failed with incident reference, not completed ok.
Acceptance	Resolve cause and verify resumed process before closure.

Map the expected result to your application

Map your actual runtime response into this proposed application contract. All values are invented examples; no credentials or live execution are included.

Expected output JSON — illustrative, not measured · CamundaAPI-expected-results.json

{
  "schema_version": "1.0.0",
  "example": true,
  "provider": "Camunda 8",
  "status": "ok",
  "input_id": "sample-001",
  "data": {
    "process_instance_key": "example-instance",
    "process_definition": "example-rfq-review",
    "business_state": "completed",
    "approved": true
  },
  "error": null,
  "verification": "illustrative-only;not-provider-response"
}

Download specification, example and acceptance plan

Engineering handoff — our proposed contract and gates
State semantics	Valid empty results differ from errors. Pending work must not appear successful before completion.
Evidence	Record service and SDK versions, request identity, configuration and response mapping. No execution or performance was measured here.
Acceptance proposal	Agree numerical tolerances and workload targets before testing on representative authorized samples.

Development assessment

Engineering approval workflow

Development concept · integration not tested

Provider capabilities above are based on official documentation or repositories. The proposed product, inputs, deliverable and acceptance criteria below are our development assessment.

Integration pilot

Validate runtime, schemas or hardware together before estimating a deployable product.

Proposed inputs: A sample event, authorized systems and one defined workflow transition.
Proposed deliverable: A visible job state and audit trail for a single workflow.
Acceptance criterion: A retried event must not create duplicate work; an unavailable upstream must remain visibly pending or failed.
Dependencies: Runtime access, workflow permissions and a reviewed notification or write destination.

Development sequence

Confirm access to Camunda Orchestration API, license and the exact supported version.
Prepare the sample above and implement one documented operation for “Engineering approval workflow”.
Normalize the result with source, time and explicit error state; keep the provider response for review.
Run the acceptance criterion before estimating rollout effort or committing a customer deliverable.

How to validate demand

Record product views, documentation clicks, specification downloads and contextual hub clicks. These are event counts, not unique people or completed integrations.

This feasibility assessment uses implementation conditions. No traffic-based rank or delivery-time promise is assigned.

Camunda Orchestration API

Choose an interface. Define a verifiable result.

Company / project overview

Top 10 technical entry points

Reference analysis

Official documentation

Expected results before implementation

Review process completed

Waiting for human task

No matching decision rule

Worker creates incident

Map the expected result to your application

Engineering approval workflow

Development sequence

How to validate demand

Related products