Topic
Scripting
Explore the data types and operations available in Scripting.
79 types · Used in operation arguments and return values.
A keyset-paginated page of the tenant's unified action catalog.
CreateCustomWorkflowActionInputInputInput for creating a custom action
CreateScriptInputInputInput for creating a script
CreateTemplateInputInputInput for creating a template
CustomWorkflowActionConnectionObjectA page of custom actions returned by listCustomWorkflowActions.
CustomWorkflowActionFilterInputInputFilter for listCustomWorkflowActions. All supplied predicates must match (AND); omitted ones are ignored.
CustomWorkflowActionIDScalarTypeID of a custom action, prefix `cac` (e.g. "cac_01K…").
CustomWorkflowActionSortInputInputOne ordering clause for a custom action listing.
CustomWorkflowActionStateObjectA tenant-defined action backed by a Script, invocable from workflows and the UI.
DataChangeEventObjectA real-time data change event delivered via subscription
DataChangeEventGroupObjectA group of data change event topics for a single resource
DeletePayloadObjectResult of a delete operation
DeleteTemplatePayloadObjectResult of deleting a template
ExecuteScriptInputInputInput for executing a Lua script in the playground
ExecuteScriptPayloadObjectResult of executing a Lua script in the playground
HelpChapterObjectPublished manual content for the Help reader.
HelpChapterInfoObjectMetadata for a published manual chapter.
HelpSearchResultObjectHybrid semantic and text manual search results.
IaCGuideObjectAn authoring guide, as a document with a stable file name. The same guides the MCP server serves, exposed so declarative tooling can sync them to a folder beside the schema.
IaCSchemaDocumentObjectThe annotated infrastructure schema and the hash that pins it
IaCSchemaDocumentPayloadObjectA schema or Lua testing contract document and the hash that pins it
IaCValidationResultObjectResult of validating one artifact
IntScalarThe `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
JSONScalarArbitrary JSON value (object, array, number, boolean, string, or null). Not introspectable — when the shape is known, prefer a typed `Type` registration. Numbers stored as numbers come back as numbers, not stringified.
LuaApiEntryObjectOne entry of a role's ctx.* surface, for editor completions and hover
LuaSampleObjectA Lua sample script with its source
LuaSampleSummaryObjectA Lua sample script without its source
LuaSampleTierEnumHow teachable a sample is meant to be
LuaScriptRoleEnumWhich profile a script is checked against.
MagicQueryInfoObjectA discoverable Magic Query noun and its accepted options.
MagicQueryOperationObjectThe real GraphQL operation + variables a Magic Query resolves to.
MagicQuerySchemaObjectInput (JSON Schema) and output (introspection) contract for a Magic Query noun.
MCPToolObjectTenant-defined Lua tool with assignment-scoped MCP invocation.
MCPToolAnalysisObjectExecution-free tool contract analysis.
MCPToolIDScalarMCP tool TypeID with prefix mcpt.
MCPToolInputInputTool authoring fields. Omitted fields retain existing values. New tools require a name; publish requires valid source and description.
MCPToolInvocationConnectionObjectThe caller's finished tool invocations.
MCPToolInvocationPayloadObjectResult of invokeMCPTool.
MCPToolPayloadObjectMCP tool write result.
MCPToolVersionObjectImmutable MCP tool publication snapshot.
MCPToolVersionIDScalarMCP tool version TypeID with prefix mcpv.
MyMCPToolObjectA published MCP tool assigned to the caller, directly or through a team, and enabled.
PublishTemplateVersionInputInputInput for publishing a template version
PublishTemplateVersionPayloadObjectResult of publishing a template version
QueryScalarScalarA URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.
RenderTemplateInputInputInput for rendering a template with context data
RenderTemplatePayloadObjectResult of rendering a template with context data
RestoreScriptVersionPayloadObjectResult of restoring a script version
RestoreTemplateVersionInputInputInput for restoring a template to a previous version
ScriptConnectionObjectPaginated list of scripts