Skip to content
Try for free
On this page

Integrations

Temporal

Start, signal, query, and manage Temporal workflow executions

Use Temporal to start and manage durable workflow executions from Sim. Connect to the server's HTTP API, supply the namespace, and add an API key if the server uses bearer authentication. Your server must expose the HTTP API at a URL Sim can reach; http://localhost:7243 is an example for a local server, not a guarantee that the API is enabled on every deployment.

  • Start executions: Supply the workflow type, task queue, and JSON arguments. Configure ID reuse policy, cron, timeouts, memo, or search attributes where needed. Signal With Start atomically signals an execution, creating it if necessary; it does not guarantee exactly-once application processing.
  • Interact with executions: Send signals, query state, or invoke an update handler and wait for its result.
  • Inspect executions: Read status, timing, pending activities, event history, or the close event. List and count use Temporal's visibility query language.
  • Manage execution lifecycle: Request cancellation, terminate immediately, or reset to a past workflow task. Schedule actions create, list, inspect, pause, unpause, trigger, or delete schedules.

Inputs use Temporal's standard json/plain payload encoding, and result payloads are decoded into JSON values. Workers must accept that encoding; custom payload codecs may need a separate adapter. A top-level JSON array is treated as the argument list; any other JSON value becomes one argument. The workflow's worker must already implement the named type and poll the selected task queue.

Starting an execution acknowledges its creation, rather than its completion. Poll its state or history before consuming a final outcome. See Temporal's workflow messaging reference for signal and update semantics.

Use the block

Use a Temporal server’s HTTP API to start or signal executions, query or update workflow state, inspect execution history and workers, manage schedules, and cancel, terminate, or reset executions. Supply an API key when the server requires bearer authentication.

Actions

Temporal Start Workflow

Start a new workflow execution on a Temporal cluster.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesUnique workflow ID for the new execution (e.g., order-1234)
workflowTypestringYesRegistered workflow type name to run (e.g., OrderWorkflow)
taskQueuestringYesTask queue the workflow worker polls (e.g., orders)
inputstringNoWorkflow input as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument
workflowIdReusePolicystringNoPolicy for reusing a closed workflow ID: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE, WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY, WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE, or WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING
workflowIdConflictPolicystringNoPolicy when a workflow with the same ID is already running: WORKFLOW_ID_CONFLICT_POLICY_FAIL, WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING, or WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING
cronSchedulestringNoCron schedule for recurring executions (e.g., "0 12 * * *")
executionTimeoutSecondsnumberNoTotal workflow execution timeout in seconds, including retries and continue-as-new
runTimeoutSecondsnumberNoTimeout for a single workflow run in seconds
memostringNoJSON object of memo fields to attach to the execution
searchAttributesstringNoJSON object of search attribute values to index the execution with

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the execution
runIdstringRun ID of the started workflow execution
startedbooleanWhether a new execution was started (false when an existing execution was reused)

Temporal Signal Workflow

Send a signal to a running Temporal workflow execution.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID of the execution to signal
runIdstringNoRun ID of a specific run to signal (defaults to the latest run)
signalNamestringYesName of the signal handler to invoke (e.g., approve-order)
signalInputstringNoSignal input as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the signaled execution
signalNamestringName of the signal that was sent

Temporal Signal With Start

Atomically signal a Temporal workflow execution, starting it first if it is not already running.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID to signal, or to start and signal (e.g., order-1234)
workflowTypestringYesRegistered workflow type name to start if the workflow is not running
taskQueuestringYesTask queue the workflow worker polls (e.g., orders)
signalNamestringYesName of the signal handler to invoke (e.g., approve-order)
inputstringNoWorkflow start input as JSON, used only when a new execution is started. A top-level array is passed as the argument list; any other value is passed as a single argument
signalInputstringNoSignal input as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument
workflowIdReusePolicystringNoPolicy for reusing a closed workflow ID: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE, WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY, WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE, or WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING
workflowIdConflictPolicystringNoPolicy when a workflow with the same ID is already running (defaults to using the existing run): WORKFLOW_ID_CONFLICT_POLICY_FAIL, WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING, or WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING
cronSchedulestringNoCron schedule for recurring executions (e.g., "0 12 * * *")
executionTimeoutSecondsnumberNoTotal workflow execution timeout in seconds, including retries and continue-as-new
runTimeoutSecondsnumberNoTimeout for a single workflow run in seconds
memostringNoJSON object of memo fields to attach to the execution
searchAttributesstringNoJSON object of search attribute values to index the execution with

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the signaled execution
runIdstringRun ID of the signaled (or newly started) execution
startedbooleanWhether this call started a new execution (false when only signaled)

Temporal Query Workflow

Run a synchronous query against the state of a Temporal workflow execution and return the result.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID of the execution to query
runIdstringNoRun ID of a specific run to query (defaults to the latest run)
queryTypestringYesName of the query handler to invoke (e.g., getStatus)
queryArgsstringNoQuery arguments as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the queried execution
queryTypestringName of the query that was run
resultjsonDecoded query result. A single payload is returned as its JSON value; multiple payloads are returned as an array

Temporal Update Workflow

Invoke an update handler on a running Temporal workflow and wait for its result. Unlike a signal, an update is validated by the workflow and returns a response.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID of the execution to update
runIdstringNoRun ID of a specific run to update (defaults to the latest run)
updateNamestringYesName of the update handler to invoke (e.g., addItem)
updateArgsstringNoUpdate arguments as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the updated execution
updateNamestringName of the update that was invoked
resultjsonDecoded update result. A single payload is returned as its JSON value; multiple payloads are returned as an array

Temporal Describe Workflow

Get the current state of a Temporal workflow execution, including status, timing, memo, search attributes, and pending activities.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID of the execution to describe
runIdstringNoRun ID of a specific run to describe (defaults to the latest run)

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the execution
runIdstringRun ID of the execution
workflowTypestringWorkflow type name
statusstringExecution status (RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, or TIMED_OUT)
startTimestringStart time of the execution (RFC 3339)
closeTimestringClose time of the execution (RFC 3339), null while running
executionTimestringEffective execution start time (RFC 3339), e.g. the first cron run time
historyLengthnumberNumber of events in the workflow history
taskQueuestringTask queue of the execution
memojsonDecoded memo fields attached to the execution
searchAttributesjsonDecoded search attribute values
pendingActivitiesarrayActivities currently pending on the execution
↳ activityIdstringActivity ID
↳ activityTypestringActivity type name
↳ statestringPending state (SCHEDULED, STARTED, CANCEL_REQUESTED, PAUSED, or PAUSE_REQUESTED)
↳ attemptnumberCurrent attempt number
↳ lastFailureMessagestringMessage of the most recent failure, if the activity is retrying

Temporal List Workflows

List workflow executions in a Temporal namespace, optionally filtered with a visibility query.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
querystringNoVisibility list filter, e.g. WorkflowType = "OrderWorkflow" AND ExecutionStatus = "Running" (empty lists all executions)
pageSizenumberNoMaximum number of executions to return per page
nextPageTokenstringNoPage token from a previous response, for pagination

Output

ParameterTypeDescription
executionsarrayWorkflow executions matching the query
↳ workflowIdstringWorkflow ID of the execution
↳ runIdstringRun ID of the execution
↳ workflowTypestringWorkflow type name
↳ statusstringExecution status (RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, or TIMED_OUT)
↳ startTimestringStart time of the execution (RFC 3339)
↳ closeTimestringClose time of the execution (RFC 3339), null while running
↳ executionTimestringEffective execution start time (RFC 3339)
↳ historyLengthnumberNumber of events in the workflow history
↳ taskQueuestringTask queue of the execution
nextPageTokenstringToken for the next page of results, null when no more pages exist

Temporal Count Workflows

Count workflow executions in a Temporal namespace matching a visibility query, with optional GROUP BY aggregation.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
querystringNoVisibility count filter, e.g. ExecutionStatus = "Running" or ... GROUP BY ExecutionStatus (empty counts all executions)

Output

ParameterTypeDescription
countnumberNumber of workflow executions matching the query
groupsarrayPer-group counts when the query uses GROUP BY (empty otherwise)
↳ valuesjsonDecoded values of the GROUP BY fields
↳ countnumberNumber of executions in the group

Temporal Get Workflow History

Fetch the event history of a Temporal workflow execution, optionally filtered to just the close event.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID of the execution
runIdstringNoRun ID of a specific run (defaults to the latest run)
maximumPageSizenumberNoMaximum number of history events to return per page
nextPageTokenstringNoPage token from a previous response, for pagination
historyEventFilterTypestringNoEvent filter: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT (default) or HISTORY_EVENT_FILTER_TYPE_CLOSE_EVENT to return only the final close event

Output

ParameterTypeDescription
eventsarrayHistory events of the workflow execution, in order
↳ eventIdnumberSequential ID of the event
↳ eventTimestringTime the event was recorded (RFC 3339)
↳ eventTypestringEvent type (e.g., WORKFLOW_EXECUTION_STARTED, ACTIVITY_TASK_COMPLETED)
↳ attributesjsonThe event's type-specific attributes (payload data is base64-encoded)
nextPageTokenstringToken for the next page of events, null when no more pages exist

Temporal Cancel Workflow

Request cooperative cancellation of a running Temporal workflow execution. The workflow decides how to respond to the request.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID of the execution to cancel
runIdstringNoRun ID of a specific run to cancel (defaults to the latest run)
reasonstringNoReason for the cancellation, recorded in the workflow history

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the execution whose cancellation was requested

Temporal Terminate Workflow

Forcefully terminate a Temporal workflow execution immediately, without giving the workflow a chance to react.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID of the execution to terminate
runIdstringNoRun ID of a specific run to terminate (defaults to the latest run)
reasonstringNoReason for the termination, recorded in the workflow history

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the terminated execution

Temporal Reset Workflow

Reset a Temporal workflow execution to a past workflow task, terminating the current run and replaying from the reset point in a new run.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
workflowIdstringYesWorkflow ID of the execution to reset
runIdstringNoRun ID of a specific run to reset (defaults to the latest run)
workflowTaskFinishEventIdnumberYesEvent ID of the workflow task finish event to reset to — a WORKFLOW_TASK_COMPLETED, WORKFLOW_TASK_TIMED_OUT, WORKFLOW_TASK_FAILED, or WORKFLOW_TASK_STARTED event (find it with Get Workflow History)
reasonstringNoReason for the reset, recorded in the workflow history

Output

ParameterTypeDescription
workflowIdstringWorkflow ID of the reset execution
runIdstringRun ID of the new run created by the reset

Temporal Describe Task Queue

List the workers currently polling a Temporal task queue, to check whether a workflow or activity has live workers.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
taskQueuestringYesName of the task queue to describe (e.g., orders)
taskQueueTypestringNoType of pollers to list: TASK_QUEUE_TYPE_WORKFLOW (default) or TASK_QUEUE_TYPE_ACTIVITY

Output

ParameterTypeDescription
taskQueuestringName of the described task queue
pollersarrayWorkers currently polling the task queue (empty when no workers are running)
↳ identitystringIdentity of the polling worker
↳ lastAccessTimestringLast time the worker polled the queue (RFC 3339)
↳ ratePerSecondnumberPoller rate per second

Temporal Create Schedule

Create a Temporal schedule that starts a workflow on a cron or interval cadence.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
scheduleIdstringYesUnique ID for the new schedule (e.g., nightly-report)
workflowIdstringYesWorkflow ID for started workflows (the schedule appends the run time to keep IDs unique)
workflowTypestringYesRegistered workflow type name the schedule starts (e.g., ReportWorkflow)
taskQueuestringYesTask queue the workflow worker polls (e.g., reports)
inputstringNoWorkflow input as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument
cronExpressionsstringNoCron expressions defining when the schedule fires, comma- or newline-separated for multiple (e.g., "0 12 * * *"). At least one of cronExpressions or intervalSeconds is required
intervalSecondsnumberNoFixed interval between actions in seconds. At least one of cronExpressions or intervalSeconds is required
timezonestringNoIANA time zone for cron evaluation (e.g., America/New_York; defaults to UTC)
overlapPolicystringNoPolicy when an action would overlap a still-running one (defaults to skip): SCHEDULE_OVERLAP_POLICY_SKIP, SCHEDULE_OVERLAP_POLICY_BUFFER_ONE, SCHEDULE_OVERLAP_POLICY_BUFFER_ALL, SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER, SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER, or SCHEDULE_OVERLAP_POLICY_ALLOW_ALL
notesstringNoHuman-readable notes stored on the schedule
pausedbooleanNoCreate the schedule in a paused state (defaults to active)

Output

ParameterTypeDescription
scheduleIdstringID of the created schedule

Temporal List Schedules

List schedules in a Temporal namespace.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
querystringNoVisibility filter over schedules, e.g. TemporalSchedulePaused = false (empty lists all schedules)
maximumPageSizenumberNoMaximum number of schedules to return per page
nextPageTokenstringNoPage token from a previous response, for pagination

Output

ParameterTypeDescription
schedulesarraySchedules in the namespace
↳ scheduleIdstringSchedule ID
↳ workflowTypestringWorkflow type the schedule starts
↳ pausedbooleanWhether the schedule is paused
↳ notesstringHuman-readable notes on the schedule
↳ futureActionTimesjsonUpcoming action times (RFC 3339)
nextPageTokenstringToken for the next page of results, null when no more pages exist

Temporal Describe Schedule

Get the configuration and current state of a Temporal schedule, including its spec, recent actions, and upcoming run times.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
scheduleIdstringYesID of the schedule to describe

Output

ParameterTypeDescription
scheduleIdstringSchedule ID
pausedbooleanWhether the schedule is paused
notesstringHuman-readable notes on the schedule
workflowTypestringWorkflow type the schedule starts
taskQueuestringTask queue used for started workflows
workflowIdstringWorkflow ID template for started workflows
specjsonSchedule spec (calendars, intervals, cron strings, jitter, time zone)
recentActionsarrayMost recent actions taken by the schedule
↳ scheduleTimestringNominal scheduled time (RFC 3339)
↳ actualTimestringActual time the action ran (RFC 3339)
↳ workflowIdstringWorkflow ID of the started execution
↳ runIdstringRun ID of the started execution
futureActionTimesjsonUpcoming action times (RFC 3339)

Temporal Pause Schedule

Pause a Temporal schedule so it stops taking actions until unpaused.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
scheduleIdstringYesID of the schedule to pause
reasonstringNoReason recorded in the schedule's notes

Output

ParameterTypeDescription
scheduleIdstringID of the paused schedule

Temporal Unpause Schedule

Unpause a Temporal schedule so it resumes taking actions.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
scheduleIdstringYesID of the schedule to unpause
reasonstringNoReason recorded in the schedule's notes

Output

ParameterTypeDescription
scheduleIdstringID of the unpaused schedule

Temporal Trigger Schedule

Trigger an immediate action of a Temporal schedule, outside its normal spec.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
scheduleIdstringYesID of the schedule to trigger
overlapPolicystringNoOverlap policy for the triggered action (defaults to the schedule's policy): SCHEDULE_OVERLAP_POLICY_SKIP, SCHEDULE_OVERLAP_POLICY_BUFFER_ONE, SCHEDULE_OVERLAP_POLICY_BUFFER_ALL, SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER, SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER, or SCHEDULE_OVERLAP_POLICY_ALLOW_ALL

Output

ParameterTypeDescription
scheduleIdstringID of the triggered schedule

Temporal Delete Schedule

Delete a Temporal schedule. Workflows already started by the schedule keep running.

Inputs and outputs

Input

ParameterTypeRequiredDescription
serverUrlstringYesBase URL of the Temporal server's HTTP API (e.g., http://localhost:7243)
namespacestringYesTemporal namespace (e.g., default)
apiKeystringNoAPI key sent as a Bearer token (leave blank for servers without auth)
scheduleIdstringYesID of the schedule to delete

Output

ParameterTypeDescription
scheduleIdstringID of the deleted schedule
Was this helpful?
Suggest an edit