Overview
This node allows you to interact with Temporal workflows by either starting a new workflow execution or retrieving the status of an existing workflow execution. It is useful in automation scenarios where you want to trigger complex, stateful workflows managed by Temporal or monitor their progress and results.
Practical examples include:
- Starting a data processing workflow with specific input parameters.
- Checking if a long-running workflow has completed, failed, or is still running.
Properties
Name | Meaning |
---|---|
Workflow ID | The unique identifier for the workflow execution. Required for both starting and status retrieval operations. |
Output
The output JSON structure depends on the selected operation:
Start Workflow: Returns an object containing:
workflowId
: The ID of the started workflow.runId
: The first execution run ID of the workflow.
Get Workflow Status: Returns an object containing:
workflowId
: The ID of the workflow.runId
: The current run ID.status
: The current status name of the workflow (e.g., Running, Completed).startTime
: Timestamp when the workflow started.closeTime
: Timestamp when the workflow closed (if applicable).
If the node encounters an error and is set to continue on failure, it outputs an object with an error
field describing the issue.
Dependencies
- Requires connection to a Temporal server, configured via credentials that include:
- Server address.
- Namespace.
- Optional TLS certificate and key file paths for secure communication.
- Uses the Temporal client library to connect and interact with workflows.
- Requires appropriate API authentication credentials configured in n8n.
Troubleshooting
Common issues:
- Invalid or missing Workflow ID will cause errors.
- Incorrect TLS certificate paths or invalid certificates can prevent connection.
- Network connectivity issues to the Temporal server.
- Malformed JSON input when starting a workflow will cause parsing errors.
Error messages:
- Errors related to connection failures usually indicate misconfigured credentials or network problems.
- JSON parsing errors occur if the "Input" property contains invalid JSON.
- Workflow not found errors happen if the specified Workflow ID does not exist.
To resolve these:
- Verify all credential fields and file paths.
- Ensure the Temporal server is reachable.
- Validate JSON input before executing.
- Confirm the Workflow ID exists in the Temporal system.