Overview
This node integrates with Temporal workflows, allowing users to start workflows, query running workflows, send signals to workflows, get workflow results, and check workflow status. It is useful for automating and managing workflow executions in Temporal, such as triggering workflows with specific inputs, querying their state, or signaling them to perform actions.
Use Case Examples
- Start a new workflow with specific input data and optionally wait for its completion.
- Query a running workflow to retrieve current data or status.
- Send a signal to a running workflow to trigger an event or update.
- Get the final result of a completed workflow after waiting for its execution to finish.
Properties
| Name | Meaning |
|---|---|
| Workflow ID | The ID of the workflow to interact with (required for query, signal, getStatus, getResult operations). |
| Signal Name | The name of the signal to send to the workflow (required for signal operation). |
| Signal Arguments | JSON arguments to pass along with the signal to the workflow (optional for signal operation). |
Output
JSON
workflowId- The ID of the workflow involved in the operation.signalName- The name of the signal sent to the workflow (only for signal operation).handle- Details of the workflow handle after signaling (only for signal operation).
Dependencies
- Temporal client library (@temporalio/client)
- An API key credential for Temporal server authentication
Troubleshooting
- Ensure the workflow ID provided exists and is correct to avoid errors when querying, signaling, or getting results.
- Verify that the Temporal server address and API key credentials are correctly configured to establish a connection.
- Check that the signal name and arguments are valid and expected by the target workflow to prevent signal delivery failures.
- If JSON arguments are malformed, parsing errors may occur; ensure valid JSON format is used.
Links
- Temporal Documentation - Official documentation for Temporal workflows and client usage.