- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 63
- Triggers: 0
- Slug:
TEMPORAL - Version: 20261101_00
Tools
Batch Cancel Workflows
Batch Cancel Workflows
TEMPORAL_BATCH_CANCEL_WORKFLOWSRequest cancellation of selected Temporal Workflows. Cancellation is cooperative: Workflow code can perform cleanup and external side effects before closing. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.Output
Batch Delete Workflows
Batch Delete Workflows
TEMPORAL_BATCH_DELETE_WORKFLOWSWARNING: Permanently delete selected Temporal Workflow Executions and their Event Histories. This cannot be undone. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.Output
Batch Reset Workflows
Batch Reset Workflows
TEMPORAL_BATCH_RESET_WORKFLOWSWARNING: Irreversibly reset selected Temporal Workflows. Each successful reset terminates the current run and creates a new run; replay and reapplied events can repeat application code and external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.Output
Batch Signal Workflows
Batch Signal Workflows
TEMPORAL_BATCH_SIGNAL_WORKFLOWSSend a named Signal to selected Temporal Workflows. Signal handlers run application code and can cause arbitrary, non-idempotent external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.Output
Batch Terminate Workflows
Batch Terminate Workflows
TEMPORAL_BATCH_TERMINATE_WORKFLOWSWARNING: Irreversibly terminate selected Temporal Workflows immediately; Workflow cleanup code does not run. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.Output
Batch Update Workflow Options
Batch Update Workflow Options
TEMPORAL_BATCH_UPDATE_WORKFLOW_OPTIONSUpdate typed execution options on selected Temporal Workflows. Worker routing, task priority, and virtual-time changes can cause application and external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.Output
Cancel Workflow
Cancel Workflow
TEMPORAL_CANCEL_WORKFLOWIrreversibly request cooperative cancellation of a running Temporal Workflow Execution. Temporal records a cancellation-requested event and schedules a Workflow Task, but the Workflow may delay or ignore cancellation depending on its code. A request for an already-closed Workflow succeeds. Requires Namespace Write access.Input Parameters
Output
Count Schedules
Count Schedules
TEMPORAL_COUNT_SCHEDULESReturn an approximate count of Temporal Schedules matching a Schedule Visibility query, including grouped counts when requested. Requires Namespace Read access.Input Parameters
Output
Count Workflows
Count Workflows
TEMPORAL_COUNT_WORKFLOWSReturn an approximate count of Workflow Executions matching a Temporal Visibility query, including supported grouped counts. Requires Namespace Read access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. This count endpoint additionally supports GROUP BY ExecutionStatus only; counts are approximate.Output
Create and Apply Workflow Rule
Create and Apply Workflow Rule
TEMPORAL_CREATE_AND_APPLY_WORKFLOW_RULECreate a Namespace-wide Temporal Workflow Rule and immediately start a batch job applying it to matching currently running Workflows. This may pause Activities across many executions and cause irreversible operational effects. Use request_id for idempotent retries. Requires Namespace Write access.Input Parameters
Output
Create Export Sink
Create Export Sink
TEMPORAL_CREATE_EXPORT_SINKCreate a persistent Temporal Cloud Workflow History export sink asynchronously. Requires Namespace Admin access. Warning: an enabled sink writes closed Workflow Histories to external storage on an ongoing schedule and may incur storage costs. Validate the destination first, use a disposable sink for testing, and arrange teardown.Input Parameters
Output
Create Schedule
Create Schedule
TEMPORAL_CREATE_SCHEDULECreate a Temporal Schedule that starts a configured Workflow on cron, interval, calendar, or structured-calendar times. The Workflow may perform arbitrary application side effects. Use request_id for idempotent retries. Requires Namespace Write access.Input Parameters
Output
Create Workflow Rule
Create Workflow Rule
TEMPORAL_CREATE_WORKFLOW_RULECreate a Namespace-wide Temporal Workflow Rule that can pause matching Activities when its trigger occurs. This does not scan currently running Workflows; use Create and Apply Workflow Rule for that separate intent. Use request_id for idempotent retries. Requires Namespace Write access.Input Parameters
Output
Delete Export Sink
Delete Export Sink
TEMPORAL_DELETE_EXPORT_SINKDelete a Temporal Cloud Workflow History export sink asynchronously. Requires Namespace Admin access. WARNING: this irreversibly stops future exports from the sink. Files already exported to external storage remain there and must be managed separately. Confirm the Namespace, sink name, and current resource version before calling.Input Parameters
Output
Delete Namespace
Delete Namespace
TEMPORAL_DELETE_NAMESPACEPermanently and irreversibly delete a Temporal Cloud Namespace and all of its Workflow data asynchronously. WARNING: there is no recovery or undo. Use only for a verified disposable Namespace after confirming its full ID, contents, latest resource version, and that deletion protection is disabled.Input Parameters
Output
Delete Schedule
Delete Schedule
TEMPORAL_DELETE_SCHEDULEPermanently delete one Temporal Schedule from a Namespace. WARNING: schedule deletion cannot be undone, but it does not terminate or otherwise affect Workflow Executions the Schedule already started. Confirm the Namespace and Schedule ID before calling. Requires Namespace Write access.Input Parameters
Output
Delete Workflow Rule
Delete Workflow Rule
TEMPORAL_DELETE_WORKFLOW_RULEPermanently delete one configured Temporal Workflow Rule from a Namespace. WARNING: deletion cannot be undone; after deletion the rule no longer applies to new triggering events. Confirm the Namespace and rule ID before calling. Requires Namespace Write access.Input Parameters
Output
Describe Batch Operation
Describe Batch Operation
TEMPORAL_DESCRIBE_BATCH_OPERATIONReturn progress, state, selection query, type, and failure counts for one batch operation in an authorized Temporal Cloud Namespace. Requires Namespace Read access.Input Parameters
Output
Describe Namespace
Describe Namespace
Describe Schedule
Describe Schedule
TEMPORAL_DESCRIBE_SCHEDULEReturn the complete current definition, state, execution information, Memo, Search Attributes, and conflict token for one Temporal Schedule. Use this before a full replacement update to preserve intended fields and guard against concurrent changes. Requires Namespace Read access.Input Parameters
Output
Describe Workflow
Describe Workflow
TEMPORAL_DESCRIBE_WORKFLOWReturn configuration, status, pending work, callbacks, and child state for one Workflow Execution in an authorized Temporal Cloud Namespace. Omit run_id to describe the current run. Requires Namespace Read access.Input Parameters
Output
Describe Workflow Rule
Describe Workflow Rule
TEMPORAL_DESCRIBE_WORKFLOW_RULEReturn one configured Temporal Workflow Rule, including its trigger, Visibility query, actions, expiration, creation metadata, and description. Requires Namespace Read access.Input Parameters
Output
Fail Over Namespace Region
Fail Over Namespace Region
TEMPORAL_FAILOVER_NAMESPACE_REGIONSwitch a multi-region Temporal Cloud Namespace’s active region asynchronously. WARNING: This operation disrupts current Namespace routing while failover completes. Require explicit approval and a documented rollback or failback plan before calling it.Input Parameters
Output
Get Async Operation
Get Async Operation
Get Export Sink
Get Export Sink
Get Namespace Capacity
Get Namespace Capacity
Get Cloud Region
Get Cloud Region
Get Workflow History
Get Workflow History
TEMPORAL_GET_WORKFLOW_HISTORYReturn one page of a Temporal Workflow Execution’s Event History in forward or reverse order. Requires Namespace Read access.Input Parameters
Output
List Archived Workflows
List Archived Workflows
TEMPORAL_LIST_ARCHIVED_WORKFLOWSReturn one page of archived Workflow Executions matching an exact Temporal Visibility query. Requires Namespace Read access and a Namespace deployment with archival visibility configured and available; the probed Namespace returned HTTP 403 even with inherited Namespace Admin access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'.Output
List Batch Operations
List Batch Operations
TEMPORAL_LIST_BATCH_OPERATIONSReturn one page of batch operations in an authorized Temporal Cloud Namespace. Requires Namespace Read access.Input Parameters
Output
List Export Sinks
List Export Sinks
List Namespace Assignments
List Namespace Assignments
TEMPORAL_LIST_NAMESPACE_ASSIGNMENTSReturn one page of users, User Groups, or Service Accounts assigned to a Temporal Cloud Namespace. Requires Namespace Read access.Input Parameters
Output
List Namespaces
List Namespaces
List Cloud Regions
List Cloud Regions
List Schedule Matching Times
List Schedule Matching Times
TEMPORAL_LIST_SCHEDULE_MATCHING_TIMESList times within a required start-to-end range that match one Temporal Schedule’s timing specification. Requires Namespace Read access.Input Parameters
Output
List Schedules
List Schedules
TEMPORAL_LIST_SCHEDULESReturn one filtered page of Temporal Schedules in an authorized Temporal Cloud Namespace. Requires Namespace Read access.Input Parameters
Output
List Workflow Rules
List Workflow Rules
TEMPORAL_LIST_WORKFLOW_RULESReturn one page of Workflow Rules configured for an authorized Temporal Cloud Namespace. Requires Namespace Read access.Input Parameters
Output
List Workflows
List Workflows
TEMPORAL_LIST_WORKFLOWSSearch one page of Workflow Executions in an authorized Temporal Cloud Namespace using Temporal Visibility query syntax. Requires Namespace Read access.Input Parameters
ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'.Output
Move Namespace To Project
Move Namespace To Project
TEMPORAL_MOVE_NAMESPACE_TO_PROJECTMove a Temporal Cloud Namespace to another Project asynchronously. WARNING: this disruptive operation can change inherited access and connectivity. Verify the source and destination Projects, preserve required connectivity rules, and obtain explicit approval before calling it.Input Parameters
Output
Patch Schedule
Patch Schedule
TEMPORAL_PATCH_SCHEDULEApply targeted changes to a Temporal Schedule without replacing its definition: pause or unpause it, trigger one immediate action, or backfill historical times. Immediate and backfill operations start application Workflows and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.Input Parameters
Output
Pause Workflow
Pause Workflow
TEMPORAL_PAUSE_WORKFLOWPause one Temporal Workflow Execution. Temporal changes its status to PAUSED, records a WORKFLOW_EXECUTION_PAUSED event, stops dispatching new Workflow and Activity Tasks, pauses executing Activities, and rejects Queries and Updates; an executing Workflow Task may still complete and server-side events continue. This operational side effect can halt business processing. Always call UNPAUSE_WORKFLOW during teardown, even if a later step fails. Requires Namespace Write access. This Temporal API is experimental.Input Parameters
Output
Query Workflow
Query Workflow
TEMPORAL_QUERY_WORKFLOWRun a synchronous, read-only Query handler against one Temporal Workflow Execution. The handler runs in Workflow context but cannot mutate Workflow state. Requires Namespace Read access.Input Parameters
Output
Register Namespace
Register Namespace
TEMPORAL_REGISTER_NAMESPACECreate a billable, persistent Temporal Cloud Namespace asynchronously, returning its full Namespace ID and operation information when provided. The name is immutable and custom Search Attributes cannot be deleted; use a unique disposable name for testing and arrange teardown only after creation completes.Input Parameters
Output
Remove Namespace Access
Remove Namespace Access
TEMPORAL_REMOVE_NAMESPACE_ACCESSRemove one user’s, user group’s, or service account’s direct permission on a Temporal Cloud Namespace by setting PERMISSION_UNSPECIFIED. Requires Namespace Admin. WARNING: this can immediately remove access or lock out the selected identity; verify inherited access and never remove the caller’s or sole administrator’s access.Input Parameters
Output
Rename Custom Search Attribute
Rename Custom Search Attribute
TEMPORAL_RENAME_CUSTOM_SEARCH_ATTRIBUTERename one custom Search Attribute in a Temporal Cloud Namespace asynchronously. This is a potentially breaking schema mutation: Temporal does not rewrite application Visibility queries or dashboards that reference the old name. Verify all consumers and use the latest Namespace resource version before starting the rename.Input Parameters
Output
Replace Workflow
Replace Workflow
TEMPORAL_REPLACE_WORKFLOWReplace a running Workflow Execution with a new execution using the same Workflow ID. WARNING: if that ID is running, Temporal irreversibly terminates the existing execution before starting the replacement. This may interrupt in-flight work, and the new Workflow may cause arbitrary external side effects. Use only when termination is explicitly intended, and use request_id for idempotent retries. Requires Namespace Write access.Input Parameters
Output
Reset Workflow
Reset Workflow
TEMPORAL_RESET_WORKFLOWWARNING: Irreversibly reset a Temporal Workflow to a selected Workflow Task event. Temporal terminates the current run and creates a new run; replay and reapplied events can repeat application code and external side effects. Verify the source run, event ID, and reapply policy before calling.Input Parameters
Output
Set Namespace Access
Set Namespace Access
TEMPORAL_SET_NAMESPACE_ACCESSSet one user’s, user group’s, or service account’s direct ADMIN, WRITE, or READ permission on a Temporal Cloud Namespace. The new permission replaces that principal’s current direct access; setting a lower permission may lock out the caller or the Namespace’s sole admin. Requires Namespace Admin.Input Parameters
Output
Signal With Start Workflow
Signal With Start Workflow
TEMPORAL_SIGNAL_WITH_START_WORKFLOWAtomically signal a running Temporal Workflow or start and signal it when absent. This may run application code and trigger external side effects; use a stable request_id when retrying the same intent. The TERMINATE_EXISTING conflict policy and deprecated TERMINATE_IF_RUNNING reuse policy can terminate a running execution before starting and signaling its replacement.Input Parameters
Output
Signal Workflow
Signal Workflow
TEMPORAL_SIGNAL_WORKFLOWSend an asynchronous Signal to one running Temporal Workflow Execution. This records a history event, schedules Workflow code, and may trigger arbitrary external business side effects. Temporal’s successful response only confirms acceptance, not handler completion. Use request_id to make retries idempotent. Requires Namespace Write access.Input Parameters
Output
Start or Get Workflow
Start or Get Workflow
TEMPORAL_START_OR_GET_WORKFLOWStart a Workflow Execution, or return the already-running execution when the Workflow ID conflicts. This action never replaces the running execution. The response has started=false when it returns the existing execution. Starting a Workflow dispatches application code and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.Input Parameters
Output
Start Workflow
Start Workflow
TEMPORAL_START_WORKFLOWStart a new Workflow Execution in an authorized Temporal Cloud Namespace. The request fails if the Workflow ID is already running; use Start or Get Workflow or Replace Workflow only when those different conflict semantics are intended. This dispatches application code and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.Input Parameters
Output
Stop Batch Operation
Stop Batch Operation
TEMPORAL_STOP_BATCH_OPERATIONRequest that Temporal stop an in-progress batch operation. This does not roll back Workflows already processed by the batch: their cancellations, terminations, signals, deletions, resets, or option changes remain in effect. Requires Namespace Write access.Input Parameters
Output
Terminate Workflow
Terminate Workflow
TEMPORAL_TERMINATE_WORKFLOWImmediately and irreversibly terminate one Temporal Workflow Execution. WARNING: termination bypasses cooperative cancellation and Workflow cleanup logic, so finally blocks, compensation, and pending work may not run. Use cancellation instead when the Workflow can clean up safely. Requires Namespace Write access.Input Parameters
Output
Trigger Workflow Rule
Trigger Workflow Rule
TEMPORAL_TRIGGER_WORKFLOW_RULETrigger an existing configured Temporal Workflow Rule against one Workflow Execution. This irreversible request evaluates the rule and, when its conditions match, may run configured actions with destructive or arbitrary external side effects. Verify the Workflow and rule before calling; do not test against production or an unknown rule. A successful request can return applied=false when the rule conditions do not match. Requires Namespace Write access.Input Parameters
Output
Unpause Workflow
Unpause Workflow
TEMPORAL_UNPAUSE_WORKFLOWResume a paused Temporal Workflow Execution. Unpausing changes its status to running, records an unpaused history event, and resumes application code in Workflow and Activity Tasks, which may produce external side effects. Use request_id for idempotent retries. This Temporal API is experimental and requires Namespace Write access.Input Parameters
Output
Update Export Sink
Update Export Sink
TEMPORAL_UPDATE_EXPORT_SINKUpdate an existing Temporal Cloud Workflow History export sink asynchronously using optimistic concurrency. WARNING: this replaces the sink’s destination configuration or enabled state for future exports and may redirect or stop Workflow History delivery; already exported files are not moved or undone. Confirm the complete current specification, destination, and resourceVersion before calling.Input Parameters
Output
Update Namespace
Update Namespace
TEMPORAL_UPDATE_NAMESPACEUpdate a Temporal Cloud Namespace specification asynchronously using the latest resource version for optimistic concurrency. WARNING: this full-spec replacement can change retention, regions, capacity, authentication, deletion protection, and high-availability behavior; newly added custom Search Attributes cannot be deleted. Preserve every unchanged field and verify API-key access and deletion protection before calling. Requires Namespace Admin access.Input Parameters
Output
Update Schedule
Update Schedule
TEMPORAL_UPDATE_SCHEDULEFully replace an existing Temporal Schedule’s spec, Workflow-start action, policies, and state. Omitted values in those structures are not preserved; supply the complete desired replacement configuration. The replacement can change when application Workflows run and may cause irreversible external side effects. Supply conflict_token to reject a stale update. Requires Namespace Write access.Input Parameters
Output
Update Workflow
Update Workflow
TEMPORAL_UPDATE_WORKFLOWSend a durable Update to one Temporal Workflow Execution and wait for the requested lifecycle stage. The Workflow handler may mutate state and cause arbitrary external business side effects. Reuse update_id only when retrying the same intended Update. An admitted or accepted response can omit outcome; the returned update_ref identifies the still-running Update. Requires Namespace Write access.Input Parameters
Output
Update Workflow Options
Update Workflow Options
TEMPORAL_UPDATE_WORKFLOW_OPTIONSUpdate selected options on one Temporal Workflow Execution using an exact protobuf FieldMask. This mutation can reroute Workflow Tasks to different Workers, change task priority, or alter virtual-time behavior and thereby cause application side effects. Use only on an intended execution, capture the prior options, and restore them when testing. Requires Namespace Write access.Input Parameters
Output
Validate Export Sink
Validate Export Sink
TEMPORAL_VALIDATE_EXPORT_SINKValidate a Temporal Cloud Workflow History export sink configuration. WARNING: this is not read-only; Temporal writes an empty test object to the configured external bucket or container. Use only an owner-approved disposable bucket or container.