Automation

Workflows

Explore the data types and operations available in Workflows.

77 operations

allWorkflowTriggersQuery

List all triggers for the current tenant. Requires workflow:list permission.

analyzeWorkflowSourceQuery

Compile XML and analyze shared workflow contracts without executing operations; JSON analysis result

cancelExecutionMutation

Cancel a running workflow execution. Requires workflow:execute permission.

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

createTemplateMutation

Create a new template. Requires template:write permission.

createWorkflowMutation

Create a new workflow. Requires workflow:write permission.

createWorkflowTriggerMutation

Create a new workflow trigger

createWorkflowVersionMutation

Create a new version of a workflow. Requires workflow:write permission.

createWorkflowVersionFromSourceMutation

Create an immutable workflow version from XML; validation is shared with all authoring paths. Does not activate it.

dataChangeEventsSubscription

Subscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).

deleteTemplateMutation

Delete a template and all its versions. Requires template:delete permission.

deleteTemplateVersionMutation

Delete one version from a template's history. Fails when the version is the one the template is currently published at. Requires template:write permission.

deleteWorkflowMutation

Delete a workflow and all its versions. Requires workflow:delete permission.

deleteWorkflowTriggerMutation

Delete a workflow trigger

deleteWorkflowVersionMutation

Delete one version from a workflow's authoring history. Fails when the workflow is active and this is the version it runs — deactivate it or activate another version first. Requires workflow:delete permission.

deleteWorkflowVersionIfExistsMutation

Idempotent workflow version cleanup; retains the active-version protection

disableWorkflowTriggerMutation

Disable a workflow trigger

enableWorkflowTriggerMutation

Enable a workflow trigger

executeWorkflowMutation

Start a new workflow execution. Requires workflow:execute permission.

executionLogStreamSubscription

Stream execution log entries as they are written for a given context. Requires integrationInstance:read.

exportWorkflowMutation

Export a workflow version to YAML or JSON. Requires workflow:read permission.

generateDefaultDataQueryQuery

Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.

getExecutionQuery

Fetch a single workflow execution by ID. Requires workflow:read permission.

getExecutionStepsQuery

Fetch all steps for a workflow execution. Requires workflow:read permission.

getMagicQueryGraphQLQuery

Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getTemplateQuery

Fetch a template by ID. Requires template:read permission.

getTemplateByHandleQuery

Fetch a template by handle. Requires template:read permission.

getTemplateVersionQuery

Fetch one template version by ID. Requires template:read permission.

getWorkflowQuery

Fetch a single workflow by ID. Requires workflow:read permission.

getWorkflowSchemaQuery

Get the JSON Schema for workflow definitions. Can be used with Zod or other validation libraries. Requires workflow:read permission.

getWorkflowVersionQuery

Fetch a single workflow version by ID. Requires workflow:read permission.

getWorkflowVersionSourceQuery

Read authoritative workflow XML for IaC, including canonical exports of legacy versions

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

importWorkflowMutation

Import a workflow from YAML or JSON, creating a new version. Requires workflow:write permission.

latestProgressQuery

Get the most recent progress snapshot for an operation. Requires progressPoint:read permission.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listExecutionLogsQuery

List execution log entries for a given context, newest first

listExecutionsQuery

List workflow executions with pagination. Requires workflow:list permission.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listTemplatesQuery

List templates with pagination and filtering. Requires template:list permission.

listTemplateVersionsQuery

List versions of a template with pagination. Requires template:read permission.

listWorkflowsQuery

List workflows with pagination. Requires workflow:list permission.

listWorkflowVersionsQuery

List workflow versions with pagination. Requires workflow:list permission.

magicQueryQuery

Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.