Process tasks
The Process Orchestration APIs are currently available as a Non-Production Preview (NPP) feature and are not available to all clients. For more information, see Process Orchestration.
Human tasks (User Tasks in BPMN terminology) are points in a process where execution pauses and waits for a person to take action before it can continue. When a process instance reaches a human task, it stops and creates a task record with the information the human needs to make a decision or submit data.
The Process Tasks API lets your application or back-office UI:
- Retrieve the details of a pending human task — including what input is expected from the human
- Submit the task completion — providing the human's response so the process can resume
Endpoint summary
| Method | Path | Description |
|---|---|---|
GET | /processtasks/{taskId} | Get a process task by ID |
PUT | /processtasks/{taskId} | Update a process task (for example, to reassign it) |
POST | /processtasks/{taskId}:complete | Complete a human task |
How human tasks work
- A process instance starts and reaches a User Task element in the BPMN definition.
- The process pauses and a task record is created with the task ID and any variables the human needs.
- Your system is notified (for example, via an event, a polling call, or a notification mechanism).
- A user retrieves the task details via
GET /processtasks/{taskId}. - The user performs the required action and your system calls
POST /processtasks/{taskId}:completewith the task result. - The process resumes and continues execution with the submitted data.
Completing a task
The completion payload is a JSON object whose fields depend on what the BPMN User Task expects. The process definition determines the required output variables. Consult the process documentation or BPMN file for the expected completion payload.
The task ID is created when the process instance reaches the User Task. Your application can discover pending tasks by polling or by listening for process events — the task ID is included in the process instance's activity history, available via the Process Instances API.