Temporal Client Node icon

Temporal Client Node

Temporal Client Node
Join our community

Overview

This node acts as a client for Temporal, a workflow orchestration platform. It allows users to start and execute Temporal workflows by specifying the namespace, task queue, workflow name, and execution parameters. The node handles connection setup with TLS authentication and manages workflow execution timeouts.

Common scenarios where this node is beneficial include:

  • Automating complex business processes that require reliable workflow orchestration.
  • Triggering Temporal workflows from n8n based on external events or data.
  • Integrating Temporal workflows into broader automation pipelines.

For example, a user can start a Temporal workflow to process an order by providing the order details as input parameters, specifying the appropriate namespace and task queue, and then handle the workflow result within n8n.

Properties

Name Meaning
Temporal命名空间 (namespace) The Temporal namespace in which the workflow runs.
Temporal任务队列 (queue) The Temporal task queue to which the workflow tasks are dispatched.
Temporal任务名称 (name) The name of the Temporal workflow to execute.
Temporal执行参数 (args) JSON object containing the arguments passed to the workflow execution.
Temporal工作流总超时时间 (execute_timeout) Total timeout duration for the entire workflow execution (e.g., "2 minutes").
Temporal工作流单次超时时间 (run_timeout) Timeout duration for a single run of the workflow (e.g., "1 minutes").
Temporal Activity超时时间 (activity_timeout) Timeout duration for individual activities within the workflow (e.g., "1 minutes").

Output

The node outputs the result of the executed Temporal workflow as JSON data. Specifically, the json output field contains the resolved value returned by the workflow's result() method.

If the workflow returns complex data structures, they will be included in the output JSON array. The node does not output binary data.

Dependencies

  • Requires a Temporal server accessible via a network address.
  • Needs TLS credentials including CA certificate, client certificate, and private key for secure connection.
  • Requires an API key credential configured in n8n for authenticating with the Temporal server.
  • Uses the official @temporalio/client Node.js package bundled within the node.

Troubleshooting

  • Connection errors: Ensure the Temporal server address and TLS certificates are correctly configured. Invalid or missing certificates will cause connection failures.
  • JSON parsing errors: The args property must be valid JSON. If provided as a string, it attempts to parse it; invalid JSON will cause errors.
  • Timeouts: If workflows exceed specified timeout values (execute_timeout, run_timeout, activity_timeout), the node may throw timeout errors. Adjust these values according to your workflow requirements.
  • Workflow start failures: Errors during workflow start (e.g., invalid workflow name or task queue) will be thrown. Enable "Continue On Fail" in n8n to capture errors without stopping the workflow.
  • Error context: When errors occur, the node attaches item index and workflow ID information to help identify the failing execution.

Links and References

Discussion