Temporal Query

Temporal Query

Certified

Query a running Temporal workflow

Sends a named query to a workflow and returns the result as a JSON string. The task fails if the workflow is not found or the query handler returns an error.

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

Query the current status of an order workflow.

yaml
id: query_order_status
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.temporal.workflow.Query
    endpoint: "localhost:7233"
    workflowId: "order-{{ inputs.orderId }}"
    queryType: "getStatus"
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.

Query type name

Must match a registered @QueryMethod on the workflow.

Workflow ID

The ID of the workflow execution to query.

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.

SubTypestring

Query arguments

List of JSON-encoded argument strings, one per query parameter.

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.

Temporal namespace

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

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

Run ID

Optional. When omitted, targets the latest open run of the given workflow ID.

Query result

JSON-encoded result returned by the workflow query handler.