Topic

Scripting

Explore the data types and operations available in Scripting.

79 types · Used in operation arguments and return values.

AvailableActionConnectionObject

A keyset-paginated page of the tenant's unified action catalog.

CreateCustomWorkflowActionInputInput

Input for creating a custom action

CreateScriptInputInput

Input for creating a script

CreateTemplateInputInput

Input for creating a template

CustomWorkflowActionConnectionObject

A page of custom actions returned by listCustomWorkflowActions.

CustomWorkflowActionFilterInputInput

Filter for listCustomWorkflowActions. All supplied predicates must match (AND); omitted ones are ignored.

CustomWorkflowActionIDScalar

TypeID of a custom action, prefix `cac` (e.g. "cac_01K…").

CustomWorkflowActionSortInputInput

One ordering clause for a custom action listing.

CustomWorkflowActionStateObject

A tenant-defined action backed by a Script, invocable from workflows and the UI.

DataChangeEventObject

A real-time data change event delivered via subscription

DataChangeEventGroupObject

A group of data change event topics for a single resource

DeletePayloadObject

Result of a delete operation

DeleteTemplatePayloadObject

Result of deleting a template

ExecuteScriptInputInput

Input for executing a Lua script in the playground

ExecuteScriptPayloadObject

Result of executing a Lua script in the playground

HelpChapterObject

Published manual content for the Help reader.

HelpChapterInfoObject

Metadata for a published manual chapter.

HelpSearchResultObject

Hybrid semantic and text manual search results.

IaCGuideObject

An 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.

IaCSchemaDocumentObject

The annotated infrastructure schema and the hash that pins it

IaCSchemaDocumentPayloadObject

A schema or Lua testing contract document and the hash that pins it

IaCValidationResultObject

Result of validating one artifact

IntScalar

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSONScalar

Arbitrary 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.

LuaApiEntryObject

One entry of a role's ctx.* surface, for editor completions and hover

LuaSampleObject

A Lua sample script with its source

LuaSampleSummaryObject

A Lua sample script without its source

LuaSampleTierEnum

How teachable a sample is meant to be

LuaScriptRoleEnum

Which profile a script is checked against.

MagicQueryInfoObject

A discoverable Magic Query noun and its accepted options.

MagicQueryOperationObject

The real GraphQL operation + variables a Magic Query resolves to.

MagicQuerySchemaObject

Input (JSON Schema) and output (introspection) contract for a Magic Query noun.

MCPToolObject

Tenant-defined Lua tool with assignment-scoped MCP invocation.

MCPToolAnalysisObject

Execution-free tool contract analysis.

MCPToolIDScalar

MCP tool TypeID with prefix mcpt.

MCPToolInputInput

Tool authoring fields. Omitted fields retain existing values. New tools require a name; publish requires valid source and description.

MCPToolInvocationConnectionObject

The caller's finished tool invocations.

MCPToolInvocationPayloadObject

Result of invokeMCPTool.

MCPToolPayloadObject

MCP tool write result.

MCPToolVersionObject

Immutable MCP tool publication snapshot.

MCPToolVersionIDScalar

MCP tool version TypeID with prefix mcpv.

MyMCPToolObject

A published MCP tool assigned to the caller, directly or through a team, and enabled.

PublishTemplateVersionInputInput

Input for publishing a template version

PublishTemplateVersionPayloadObject

Result of publishing a template version

QueryScalarScalar

A URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.

RenderTemplateInputInput

Input for rendering a template with context data

RenderTemplatePayloadObject

Result of rendering a template with context data

RestoreScriptVersionPayloadObject

Result of restoring a script version

RestoreTemplateVersionInputInput

Input for restoring a template to a previous version

ScriptConnectionObject

Paginated list of scripts