Automation
Workflows
Explore the data types and operations available in Workflows.
77 operations
List all triggers for the current tenant. Requires workflow:list permission.
analyzeWorkflowSourceQueryCompile XML and analyze shared workflow contracts without executing operations; JSON analysis result
cancelExecutionMutationCancel a running workflow execution. Requires workflow:execute permission.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
createTemplateMutationCreate a new template. Requires template:write permission.
createWorkflowMutationCreate a new workflow. Requires workflow:write permission.
createWorkflowTriggerMutationCreate a new workflow trigger
createWorkflowVersionMutationCreate a new version of a workflow. Requires workflow:write permission.
createWorkflowVersionFromSourceMutationCreate an immutable workflow version from XML; validation is shared with all authoring paths. Does not activate it.
dataChangeEventsSubscriptionSubscribe 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).
deleteTemplateMutationDelete a template and all its versions. Requires template:delete permission.
deleteTemplateVersionMutationDelete one version from a template's history. Fails when the version is the one the template is currently published at. Requires template:write permission.
deleteWorkflowMutationDelete a workflow and all its versions. Requires workflow:delete permission.
deleteWorkflowTriggerMutationDelete a workflow trigger
deleteWorkflowVersionMutationDelete 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.
deleteWorkflowVersionIfExistsMutationIdempotent workflow version cleanup; retains the active-version protection
disableWorkflowTriggerMutationDisable a workflow trigger
enableWorkflowTriggerMutationEnable a workflow trigger
executeWorkflowMutationStart a new workflow execution. Requires workflow:execute permission.
executionLogStreamSubscriptionStream execution log entries as they are written for a given context. Requires integrationInstance:read.
exportWorkflowMutationExport a workflow version to YAML or JSON. Requires workflow:read permission.
generateDefaultDataQueryQueryGenerate 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.
getExecutionQueryFetch a single workflow execution by ID. Requires workflow:read permission.
getExecutionStepsQueryFetch all steps for a workflow execution. Requires workflow:read permission.
getMagicQueryGraphQLQueryResolves 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.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getTemplateQueryFetch a template by ID. Requires template:read permission.
getTemplateByHandleQueryFetch a template by handle. Requires template:read permission.
getTemplateVersionQueryFetch one template version by ID. Requires template:read permission.
getWorkflowQueryFetch a single workflow by ID. Requires workflow:read permission.
getWorkflowSchemaQueryGet the JSON Schema for workflow definitions. Can be used with Zod or other validation libraries. Requires workflow:read permission.
getWorkflowVersionQueryFetch a single workflow version by ID. Requires workflow:read permission.
getWorkflowVersionSourceQueryRead authoritative workflow XML for IaC, including canonical exports of legacy versions
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery 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.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
importWorkflowMutationImport a workflow from YAML or JSON, creating a new version. Requires workflow:write permission.
latestProgressQueryGet the most recent progress snapshot for an operation. Requires progressPoint:read permission.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listExecutionLogsQueryList execution log entries for a given context, newest first
listExecutionsQueryList workflow executions with pagination. Requires workflow:list permission.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listTemplatesQueryList templates with pagination and filtering. Requires template:list permission.
listTemplateVersionsQueryList versions of a template with pagination. Requires template:read permission.
listWorkflowsQueryList workflows with pagination. Requires workflow:list permission.
listWorkflowVersionsQueryList workflow versions with pagination. Requires workflow:list permission.
magicQueryQueryExecutes 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.