Topic
Scripting
Explore the data types and operations available in Scripting.
69 operations
Infer and decorate a tool contract without saving or running it.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
createCustomWorkflowActionMutationCreate a new custom action. Requires customWorkflowAction:write permission.
createMCPToolMutationCreate a tool definition. Requires mcpTool:write.
createScriptMutationCreate a new script. Requires script:write permission.
createTemplateMutationCreate a new template. Requires template:write permission.
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).
deleteCustomWorkflowActionMutationPermanently delete a custom action from the caller's tenant. Reports notFound when no such action exists. Requires customWorkflowAction:delete permission.
deleteMCPToolMutationDelete a tool and its versions and assignments.
deleteScriptMutationDelete a script. Requires script:delete permission.
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.
executeLuaScriptMutationExecute a Lua script in the playground sandbox. Requires script:execute 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.
getCustomWorkflowActionQueryFetch a single custom action by id within the caller's tenant. Returns null when no such action exists. Requires customWorkflowAction:read permission.
getLuaSampleQueryFetch one Lua sample with its runnable source. Requires script:read.
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.
getScriptQueryFetch a script by ID. Requires script:read permission.
getScriptByNameQueryFetch a script by name. Requires script:read permission.
getScriptVersionQueryFetch one version of a script. Requires script:read permission.
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.
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.
invokeMCPToolMutationRun an assigned tool as the caller and record the run. Any signed-in user; assignment is the grant. The tool's effects are real and are not rolled back.
listAvailableActionsQueryThe tenant's unified action catalog: every active custom action plus every action declared by an active integration instance, ordered by label and keyset-paginated. Inactive custom actions are omitted. Requires customWorkflowAction:list permission.
listCustomWorkflowActionsQueryList the caller's tenant's custom actions, filtered and sorted. Requires customWorkflowAction:list permission.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listLuaSamplesQueryList the platform's Lua sample scripts. Metadata only — fetch source with getLuaSample. Every sample is type-checked and executed by tests. Requires script:read.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listScriptsQueryList scripts with pagination and filtering. Requires script:list permission.
listScriptVersionsQueryA script's history, newest first. Requires script:read permission.
listTemplatesQueryList templates with pagination and filtering. Requires template:list permission.
listTemplateVersionsQueryList versions of a template with pagination. Requires template:read permission.
luaApiSurfaceQueryStructured ctx.* or bridge.* surface for editor completions and hover. Requires script:read.
luaTypeDefinitionsQueryType definitions for a scripting role, rendered from the surface the validator checks against. Requires script:read.
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.
mcpToolQueryRead the authoring definition and assignments.
mcpToolsQueryList tenant tools for administration; not the end-user catalog.
mcpToolVersionsQueryRead immutable publication history.
myMCPToolInvocationsQueryThe caller's own finished tool invocations, newest first. Nobody else's are ever listed; still-running ones are left out.
myMCPToolsQueryThe caller's tool catalog: enabled, published tools assigned to them directly or through a team. Any signed-in user; assignment is the grant.
pingQueryHealth check endpoint
publishMCPToolMutationAnalyze and publish the current draft atomically.