Automation

Workflows

Explore the data types and operations available in Workflows.

77 operations

pingQuery

Health check endpoint

productionSnapshotQuery

Read production resources with batched evidence. Also requires workCenter:read; cell, operation, progress and job permissions are checked independently.

publishTemplateVersionMutation

Publish current template content as a new version. Requires template:write permission.

queryProgressPointsQuery

Query progress tracking points with time range and dimensional filters, keyset-paginated in descending timestamp order. Requires progressPoint:list permission.

reconcileWorkflowExecutionRuntimeMutation

Record authenticated, audited evidence that the exact predecessor process has terminated before workflow recovery. Requires workflow:reconcileRuntime permission.

recordProgressPointsMutation

Record one or more progress tracking data points. Up to 10,000 points per request. Requires progressPoint:write permission.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

renderTemplateMutation

Render a template with context data. Requires template:execute permission.

resolveNodeOutputSchemaMutation

Resolve the best-effort JSON Schema for a node's output given its config — SwiftLua-inferred for script-backed kinds, falling back to the kind's static declared schema. Requires workflow:read permission.

restoreTemplateVersionMutation

Restore template content from a previous version. Requires template:write permission.

resumeWorkflowExecutionMutation

Resume a workflow execution that is waiting for an external signal. Requires workflow:execute permission.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

setActiveVersionMutation

Set the active version of a workflow. Requires workflow:write permission.

topicExamplesQuery

Fetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.

updateTemplateMutation

Update a template. Only provided fields are changed. Requires template:write permission.

updateWorkflowMutation

Update an existing workflow. Requires workflow:write permission.

updateWorkflowTriggerMutation

Update an existing workflow trigger

upsertTemplateMutation

Create or update a template. Requires template:write permission.

validateJinjaMutation

Statically validate a workflow expression (parse + filter-name check) without evaluating it. Safe to call from editors on every keystroke.

validateTemplateMutation

Validate template syntax without saving. Requires template:read permission.

validateWorkflowMutation

Validate a workflow definition without importing it. Requires workflow:read permission.

workflowExecutionRuntimeManagementQuery

Inspect the exact workflow runner authority and audited recovery revision. Requires workflow:read permission.

workflowRunHealthQuery

Run health of every workflow in the tenant that has a run since `since` or a run currently waiting: failures in the window, waiting runs and the latest run's status. Requires workflow:list permission.

workflowRunStatsQuery

Aggregate a workflow's runs over a time window: totals by status, duration percentiles, time buckets and per-node outcomes. Requires workflow:list permission.

workflowTriggerQuery

Get a workflow trigger by ID. Requires workflow:read permission.

workflowTriggersQuery

List all triggers for a workflow. Requires workflow:list permission.