Temporal Trigger

Temporal Trigger

Certified

Trigger a Temporal workflow execution

Starts a new Temporal workflow and returns its workflow ID and run ID. If a workflow with the given ID is already running, the task fails with a clear error message.

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

Trigger an order-processing workflow on a local Temporal server.

yaml
id: trigger_order_workflow
namespace: company.team

tasks:
  - id: start
    type: io.kestra.plugin.temporal.workflow.Trigger
    endpoint: "localhost:7233"
    namespace: "default"
    workflowType: "OrderWorkflow"
    taskQueue: "order-queue"
    workflowId: "order-{{ execution.id }}"
    input:
      - '{"orderId": "ORD-123", "amount": 99.99}'
    executionTimeout: "PT1H"

Trigger a workflow on Temporal Cloud using an API key.

yaml
id: trigger_cloud_workflow
namespace: company.team

tasks:
  - id: start
    type: io.kestra.plugin.temporal.workflow.Trigger
    endpoint: "myns.tmprl.cloud:7233"
    namespace: "myns.accountId"
    apiKey: "{{ secret('TEMPORAL_API_KEY') }}"
    workflowType: "OrderWorkflow"
    taskQueue: "order-queue"
Properties

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.

Task queue name

The worker polling this queue will pick up the workflow.

Registered workflow type name

Must match the @WorkflowMethod implementation registered on the worker.

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.

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.

PEM-encoded client certificate

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

PEM-encoded client private key

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

Maximum time allowed for the workflow to complete

ISO-8601 duration, e.g. PT1H for one hour.

SubTypestring

Workflow input arguments

List of JSON-encoded argument strings, one per workflow parameter. Example: ["{"key": "value"}", "42"]

Temporal namespace

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

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

Workflow ID

Optional. A UUID is generated when absent.

Run ID

The unique run ID assigned by Temporal to this execution.

Workflow ID

The ID of the started workflow execution.