Overview
This node integrates with Camunda Cloud to manage BPMN process instances. Specifically, the Process Instance - Create operation allows users to start a new instance of a BPMN process by specifying its identifier and optional variables. This is useful in automation workflows where you want to trigger business processes programmatically based on external events or data.
Common scenarios:
- Starting a new order fulfillment process when an order is received.
- Initiating a customer onboarding workflow after form submission.
- Launching any custom BPMN-defined process dynamically from n8n.
Example:
You have a BPMN process defined for handling support tickets. When a new ticket arrives, this node can create a process instance with ticket details passed as variables, triggering the entire workflow automatically.
Properties
| Name | Meaning |
|---|---|
| BPMN Process ID | Identifier of the BPMN process definition to start a new instance of that process. |
| Variables (JSON) | JSON object containing variables to pass into the process instance at creation time. |
Output
The node outputs an array of JSON objects representing the created process instances. Each object contains details returned by Camunda Cloud about the newly started process instance, such as its unique identifiers and state.
The output is structured as:
[
{
"processInstanceKey": "...",
"bpmnProcessId": "...",
"version": ...,
"variables": { ... }
}
]
(Note: The exact fields depend on Camunda's API response.)
No binary data is produced by this operation.
Dependencies
- Requires connection to Camunda Cloud via an API authentication credential configured in n8n.
- Uses the Zeebe Node.js client library internally to communicate with Camunda Cloud.
- The node expects a valid BPMN process deployed in Camunda Cloud identified by the provided BPMN Process ID.
Troubleshooting
- Invalid BPMN Process ID: If the specified BPMN Process ID does not exist or is misspelled, the node will fail to create the instance. Verify the process ID matches exactly what is deployed in Camunda Cloud.
- Malformed Variables JSON: If the variables input is not valid JSON or not an object, the node defaults to an empty object but may cause unexpected behavior downstream. Ensure variables are properly formatted JSON objects.
- Authentication Errors: Failure to connect to Camunda Cloud usually indicates missing or invalid API credentials. Confirm the API key/token is correctly set up in n8n credentials.
- Network Issues: Timeouts or connectivity problems can cause errors. Check network access to Camunda Cloud endpoints.
If the node is set to continue on failure, errors will be returned as part of the output array with an error field describing the issue.