Overview
This node interacts with Temporal, a workflow orchestration platform. It allows users to start new workflows or retrieve the status of existing workflow executions within Temporal. This is useful for automating and monitoring complex business processes that require reliable execution and state management.
Common scenarios include:
- Starting a predefined workflow with specific input data to automate tasks.
- Checking the current status of a running or completed workflow to monitor progress or results.
For example, you might use this node to trigger an order processing workflow and later query its status to update your system or notify users.
Properties
| Name | Meaning |
|---|---|
| Workflow ID | The unique identifier of the workflow execution to start or query. |
Additional properties (not requested but relevant for context):
- Workflow Type: The type/name of the workflow to execute (only for starting workflows).
- Task Queue: The task queue to assign the workflow to (only for starting workflows).
- Input: JSON-formatted input data passed to the workflow when starting it.
Output
For Get Workflow Status operation, the output JSON contains:
workflowId: The workflow's unique ID.runId: The run instance ID of the workflow.status: The current status name of the workflow execution (e.g., Running, Completed).startTime: Timestamp when the workflow started.closeTime: Timestamp when the workflow closed (if applicable).
For Start Workflow operation (not requested but related), the output includes a
resultfield with the execution result.
The node does not output binary data.
Dependencies
- Requires connection to a Temporal server with proper address and namespace configuration.
- Needs an API authentication credential configured in n8n to connect securely.
- Optionally supports TLS client certificates if specified in credentials.
- Uses the Temporal Node.js client library internally.
Troubleshooting
- Connection failures: Errors connecting to the Temporal server may occur if the server is down, the address is incorrect, network issues exist, or TLS settings are misconfigured. The error message guides verifying these points.
- Invalid Workflow ID: Providing a non-existent or malformed workflow ID will cause errors when querying status.
- JSON Input Parsing: When starting workflows, invalid JSON input will cause parsing errors.
- Continue on Fail: If enabled, the node will continue processing other items even if one fails, returning error messages in the output JSON.