Run your first workflow

Choose a small process

Start with one service task between a start and an end event. Give the service task a job type your worker will handle. Match that exact type when activating work.

Follow one complete execution

1. Deploy the BPMN model with POST /api/v1/process-definitions, as a multipart file or a raw XML body. It answers 200 with deployments, each naming the bpmnProcessId and its version. This route deploys BPMN only and costs nothing.
2. Start an instance with POST /api/v1/process-instances and {"bpmnProcessId": "...", "variables": {...}}. It answers 201 with the processInstanceKey and costs 1 credit. The newest deployed version always starts.
3. Activate the task's job with POST /api/v1/jobs/activate and {"type", "maxJobsToActivate"}, process its variables, then complete it with POST /api/v1/jobs/{key}/complete, which answers 204 with an empty body.
4. Read the instance with GET /api/v1/process-instances/{key}. COMPLETED means it finished. INCIDENT means the run failed; it cannot be resumed over REST today, so fix the cause and start a new instance.

Use the published endpoint contracts

Keys and identifiers are opaque strings, never numbers. DMN and CMMN models deploy through POST /api/v1/models, not the process-definitions route. Errors are JSON bodies of the form {"error": "..."}.