Temporal Wait

Temporal Wait
Certified
Wait for a Temporal workflow to reach a terminal state

Polls DescribeWorkflowExecution at a configurable interval until the workflow completes, fails, is canceled, terminated, or times out.

On COMPLETED, retrieves and returns the workflow result as JSON. On other terminal states, fails the task by default; set failOnNonCompleted: false to emit the status instead.

yaml
type: io.kestra.plugin.temporal.workflow.Wait

Examples

Trigger an order workflow and wait for it to finish.

yaml
id: wait_order_workflow
namespace: company.team

tasks:
  - id: trigger
    type: io.kestra.plugin.temporal.workflow.Trigger
    endpoint: "localhost:7233"
    workflowType: "OrderWorkflow"
    taskQueue: "order-queue"
    workflowId: "order-{{ execution.id }}"

  - id: wait
    type: io.kestra.plugin.temporal.workflow.Wait
    endpoint: "localhost:7233"
    workflowId: "{{ outputs.trigger.workflowId }}"
    runId: "{{ outputs.trigger.runId }}"
    pollInterval: "PT5S"
    waitTimeout: "PT1H"

Properties

endpoint *string

Temporal server endpoint

Host and port of the Temporal frontend service in host: port format. For Temporal Cloud, use the gRPC endpoint for your namespace, e.g. <namespace>.tmprl.cloud: 7233.

workflowId *string

Workflow ID

The ID of the workflow execution to wait on.

apiKey string

API key for Bearer token authentication

Used with Temporal Cloud. Sent as Authorization: Bearer <apiKey> on every gRPC call; TLS is enabled automatically when this property is set. Mutually exclusive with mTLS properties.

caCert string

PEM-encoded CA certificate

Verifies the server certificate. Can be used alone for one-way TLS with a custom CA, or together with clientCert/clientKey for mTLS.

clientCert string

PEM-encoded client certificate

Used in mTLS mode. Must be provided together with clientKey.

clientKey string

PEM-encoded client private key

Used in mTLS mode. Must be provided together with clientCert.

failOnNonCompleted booleanstring

Defaulttrue

Fail if the workflow ends in a non-COMPLETED state

When true (default), the task throws an exception for FAILED, CANCELED, TERMINATED, or TIMED_OUT terminal states. When false, the task succeeds and reports the status in the status output.

namespace string

Temporal namespace

Defaults to default. For Temporal Cloud, typically <namespace>.<accountId>.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

pollInterval string

Poll interval

How often to check the workflow status. Defaults to 5 seconds.

runId string

Run ID

Optional. When omitted, waits on the latest run of the given workflow ID.

waitTimeout string

Maximum wait time

Total time to wait before giving up. Defaults to 1 hour. Named waitTimeout because timeout is a reserved Kestra task property that kills the task run instead of returning an output.

Outputs

result string

Workflow result

JSON-encoded return value of the workflow. Null for non-COMPLETED states.

status string

Workflow terminal status

One of: COMPLETED, FAILED, CANCELED, TERMINATED, TIMED_OUT, CONTINUED_AS_NEW.