Connect to a Temporal cluster over the server's HTTP API to start workflow executions, send signals, run queries against workflow state, describe and list executions, fetch event histories, and cancel or terminate running workflows. API key only required for servers with authentication enabled.
Start a new workflow execution on a Temporal cluster.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Unique workflow ID for the new execution (e.g., order-1234) |
workflowType | string | Ja | Registered workflow type name to run (e.g., OrderWorkflow) |
taskQueue | string | Ja | Task queue the workflow worker polls (e.g., orders) |
input | string | Nein | Workflow 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 |
workflowIdReusePolicy | string | Nein | Policy 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 |
workflowIdConflictPolicy | string | Nein | Policy 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 |
cronSchedule | string | Nein | Cron schedule for recurring executions (e.g., "0 12 * * *") |
executionTimeoutSeconds | number | Nein | Total workflow execution timeout in seconds, including retries and continue-as-new |
runTimeoutSeconds | number | Nein | Timeout for a single workflow run in seconds |
memo | string | Nein | JSON object of memo fields to attach to the execution |
searchAttributes | string | Nein | JSON object of search attribute values to index the execution with |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the execution |
runId | string | Run ID of the started workflow execution |
started | boolean | Whether a new execution was started (false when an existing execution was reused) |
Send a signal to a running Temporal workflow execution.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID of the execution to signal |
runId | string | Nein | Run ID of a specific run to signal (defaults to the latest run) |
signalName | string | Ja | Name of the signal handler to invoke (e.g., approve-order) |
signalInput | string | Nein | Signal 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 |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the signaled execution |
signalName | string | Name of the signal that was sent |
Atomically signal a Temporal workflow, starting it first if it is not already running, so the signal is never lost.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID to signal, or to start and signal (e.g., order-1234) |
workflowType | string | Ja | Registered workflow type name to start if the workflow is not running |
taskQueue | string | Ja | Task queue the workflow worker polls (e.g., orders) |
signalName | string | Ja | Name of the signal handler to invoke (e.g., approve-order) |
input | string | Nein | Workflow 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 |
signalInput | string | Nein | Signal 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 |
workflowIdReusePolicy | string | Nein | Policy 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 |
workflowIdConflictPolicy | string | Nein | Policy 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 |
cronSchedule | string | Nein | Cron schedule for recurring executions (e.g., "0 12 * * *") |
executionTimeoutSeconds | number | Nein | Total workflow execution timeout in seconds, including retries and continue-as-new |
runTimeoutSeconds | number | Nein | Timeout for a single workflow run in seconds |
memo | string | Nein | JSON object of memo fields to attach to the execution |
searchAttributes | string | Nein | JSON object of search attribute values to index the execution with |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the signaled execution |
runId | string | Run ID of the signaled (or newly started) execution |
started | boolean | Whether this call started a new execution (false when only signaled) |
Run a synchronous query against the state of a Temporal workflow execution and return the result.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID of the execution to query |
runId | string | Nein | Run ID of a specific run to query (defaults to the latest run) |
queryType | string | Ja | Name of the query handler to invoke (e.g., getStatus) |
queryArgs | string | Nein | Query 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 |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the queried execution |
queryType | string | Name of the query that was run |
result | json | Decoded query result. A single payload is returned as its JSON value; multiple payloads are returned as an array |
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.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID of the execution to update |
runId | string | Nein | Run ID of a specific run to update (defaults to the latest run) |
updateName | string | Ja | Name of the update handler to invoke (e.g., addItem) |
updateArgs | string | Nein | Update 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 |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the updated execution |
updateName | string | Name of the update that was invoked |
result | json | Decoded update result. A single payload is returned as its JSON value; multiple payloads are returned as an array |
Get the current state of a Temporal workflow execution, including status, timing, memo, search attributes, and pending activities.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID of the execution to describe |
runId | string | Nein | Run ID of a specific run to describe (defaults to the latest run) |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the execution |
runId | string | Run ID of the execution |
workflowType | string | Workflow type name |
status | string | Execution status (RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, or TIMED_OUT) |
startTime | string | Start time of the execution (RFC 3339) |
closeTime | string | Close time of the execution (RFC 3339), null while running |
executionTime | string | Effective execution start time (RFC 3339), e.g. the first cron run time |
historyLength | number | Number of events in the workflow history |
taskQueue | string | Task queue of the execution |
memo | json | Decoded memo fields attached to the execution |
searchAttributes | json | Decoded search attribute values |
pendingActivities | array | Activities currently pending on the execution |
↳ activityId | string | Activity ID |
↳ activityType | string | Activity type name |
↳ state | string | Pending state (SCHEDULED, STARTED, CANCEL_REQUESTED, PAUSED, or PAUSE_REQUESTED) |
↳ attempt | number | Current attempt number |
↳ lastFailureMessage | string | Message of the most recent failure, if the activity is retrying |
List workflow executions in a Temporal namespace, optionally filtered with a visibility query.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
query | string | Nein | Visibility list filter, e.g. WorkflowType = "OrderWorkflow" AND ExecutionStatus = "Running" (empty lists all executions) |
pageSize | number | Nein | Maximum number of executions to return per page |
nextPageToken | string | Nein | Page token from a previous response, for pagination |
| Parameter | Typ | Beschreibung |
|---|
executions | array | Workflow executions matching the query |
↳ workflowId | string | Workflow ID of the execution |
↳ runId | string | Run ID of the execution |
↳ workflowType | string | Workflow type name |
↳ status | string | Execution status (RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, or TIMED_OUT) |
↳ startTime | string | Start time of the execution (RFC 3339) |
↳ closeTime | string | Close time of the execution (RFC 3339), null while running |
↳ executionTime | string | Effective execution start time (RFC 3339) |
↳ historyLength | number | Number of events in the workflow history |
↳ taskQueue | string | Task queue of the execution |
nextPageToken | string | Token for the next page of results, null when no more pages exist |
Count workflow executions in a Temporal namespace matching a visibility query, with optional GROUP BY aggregation.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
query | string | Nein | Visibility count filter, e.g. ExecutionStatus = "Running" or ... GROUP BY ExecutionStatus (empty counts all executions) |
| Parameter | Typ | Beschreibung |
|---|
count | number | Number of workflow executions matching the query |
groups | array | Per-group counts when the query uses GROUP BY (empty otherwise) |
↳ values | json | Decoded values of the GROUP BY fields |
↳ count | number | Number of executions in the group |
Fetch the event history of a Temporal workflow execution, optionally filtered to just the close event.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID of the execution |
runId | string | Nein | Run ID of a specific run (defaults to the latest run) |
maximumPageSize | number | Nein | Maximum number of history events to return per page |
nextPageToken | string | Nein | Page token from a previous response, for pagination |
historyEventFilterType | string | Nein | Event filter: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT (default) or HISTORY_EVENT_FILTER_TYPE_CLOSE_EVENT to return only the final close event |
| Parameter | Typ | Beschreibung |
|---|
events | array | History events of the workflow execution, in order |
↳ eventId | number | Sequential ID of the event |
↳ eventTime | string | Time the event was recorded (RFC 3339) |
↳ eventType | string | Event type (e.g., WORKFLOW_EXECUTION_STARTED, ACTIVITY_TASK_COMPLETED) |
↳ attributes | json | The event's type-specific attributes (payload data is base64-encoded) |
nextPageToken | string | Token for the next page of events, null when no more pages exist |
Request cooperative cancellation of a running Temporal workflow execution. The workflow decides how to respond to the request.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID of the execution to cancel |
runId | string | Nein | Run ID of a specific run to cancel (defaults to the latest run) |
reason | string | Nein | Reason for the cancellation, recorded in the workflow history |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the execution whose cancellation was requested |
Forcefully terminate a Temporal workflow execution immediately, without giving the workflow a chance to react.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID of the execution to terminate |
runId | string | Nein | Run ID of a specific run to terminate (defaults to the latest run) |
reason | string | Nein | Reason for the termination, recorded in the workflow history |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the terminated execution |
Reset a Temporal workflow execution to a past workflow task, terminating the current run and replaying from the reset point in a new run.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
workflowId | string | Ja | Workflow ID of the execution to reset |
runId | string | Nein | Run ID of a specific run to reset (defaults to the latest run) |
workflowTaskFinishEventId | number | Ja | Event 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) |
reason | string | Nein | Reason for the reset, recorded in the workflow history |
| Parameter | Typ | Beschreibung |
|---|
workflowId | string | Workflow ID of the reset execution |
runId | string | Run ID of the new run created by the reset |
List the workers currently polling a Temporal task queue, to check whether a workflow or activity has live workers.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
taskQueue | string | Ja | Name of the task queue to describe (e.g., orders) |
taskQueueType | string | Nein | Type of pollers to list: TASK_QUEUE_TYPE_WORKFLOW (default) or TASK_QUEUE_TYPE_ACTIVITY |
| Parameter | Typ | Beschreibung |
|---|
taskQueue | string | Name of the described task queue |
pollers | array | Workers currently polling the task queue (empty when no workers are running) |
↳ identity | string | Identity of the polling worker |
↳ lastAccessTime | string | Last time the worker polled the queue (RFC 3339) |
↳ ratePerSecond | number | Poller rate per second |
Create a Temporal schedule that starts a workflow on a cron or interval cadence.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
scheduleId | string | Ja | Unique ID for the new schedule (e.g., nightly-report) |
workflowId | string | Ja | Workflow ID for started workflows (the schedule appends the run time to keep IDs unique) |
workflowType | string | Ja | Registered workflow type name the schedule starts (e.g., ReportWorkflow) |
taskQueue | string | Ja | Task queue the workflow worker polls (e.g., reports) |
input | string | Nein | Workflow 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 |
cronExpressions | string | Nein | Cron 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 |
intervalSeconds | number | Nein | Fixed interval between actions in seconds. At least one of cronExpressions or intervalSeconds is required |
timezone | string | Nein | IANA time zone for cron evaluation (e.g., America/New_York; defaults to UTC) |
overlapPolicy | string | Nein | Policy 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 |
notes | string | Nein | Human-readable notes stored on the schedule |
paused | boolean | Nein | Create the schedule in a paused state (defaults to active) |
| Parameter | Typ | Beschreibung |
|---|
scheduleId | string | ID of the created schedule |
List schedules in a Temporal namespace.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
query | string | Nein | Visibility filter over schedules, e.g. TemporalSchedulePaused = false (empty lists all schedules) |
maximumPageSize | number | Nein | Maximum number of schedules to return per page |
nextPageToken | string | Nein | Page token from a previous response, for pagination |
| Parameter | Typ | Beschreibung |
|---|
schedules | array | Schedules in the namespace |
↳ scheduleId | string | Schedule ID |
↳ workflowType | string | Workflow type the schedule starts |
↳ paused | boolean | Whether the schedule is paused |
↳ notes | string | Human-readable notes on the schedule |
↳ futureActionTimes | json | Upcoming action times (RFC 3339) |
nextPageToken | string | Token for the next page of results, null when no more pages exist |
Get the configuration and current state of a Temporal schedule, including its spec, recent actions, and upcoming run times.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
scheduleId | string | Ja | ID of the schedule to describe |
| Parameter | Typ | Beschreibung |
|---|
scheduleId | string | Schedule ID |
paused | boolean | Whether the schedule is paused |
notes | string | Human-readable notes on the schedule |
workflowType | string | Workflow type the schedule starts |
taskQueue | string | Task queue used for started workflows |
workflowId | string | Workflow ID template for started workflows |
spec | json | Schedule spec (calendars, intervals, cron strings, jitter, time zone) |
recentActions | array | Most recent actions taken by the schedule |
↳ scheduleTime | string | Nominal scheduled time (RFC 3339) |
↳ actualTime | string | Actual time the action ran (RFC 3339) |
↳ workflowId | string | Workflow ID of the started execution |
↳ runId | string | Run ID of the started execution |
futureActionTimes | json | Upcoming action times (RFC 3339) |
Pause a Temporal schedule so it stops taking actions until unpaused.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
scheduleId | string | Ja | ID of the schedule to pause |
reason | string | Nein | Reason recorded in the schedule's notes |
| Parameter | Typ | Beschreibung |
|---|
scheduleId | string | ID of the paused schedule |
Unpause a Temporal schedule so it resumes taking actions.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
scheduleId | string | Ja | ID of the schedule to unpause |
reason | string | Nein | Reason recorded in the schedule's notes |
| Parameter | Typ | Beschreibung |
|---|
scheduleId | string | ID of the unpaused schedule |
Trigger an immediate action of a Temporal schedule, outside its normal spec.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
scheduleId | string | Ja | ID of the schedule to trigger |
overlapPolicy | string | Nein | Overlap 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 |
| Parameter | Typ | Beschreibung |
|---|
scheduleId | string | ID of the triggered schedule |
Delete a Temporal schedule. Workflows already started by the schedule keep running.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
serverUrl | string | Ja | Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\) |
namespace | string | Ja | Temporal namespace (e.g., default) |
apiKey | string | Nein | API key sent as a Bearer token (leave blank for servers without auth) |
scheduleId | string | Ja | ID of the schedule to delete |
| Parameter | Typ | Beschreibung |
|---|
scheduleId | string | ID of the deleted schedule |
