Skip to content

MCP Tool Reference

What must an assistant send, and what can it expect back? Each entry below gives a typed MCP tool’s inputs, access requirements, annotations, and output schema. Use the exact input names; the server rejects unknown parameters and checks required values before executing a call.

For the Invoice intake example, first find the workflow with workflow_list, then read its Check invoice flow with flow_list and flow_get. Retain the workflow ID from data.items[].workflowId and the flow ID from the flow list for later calls; scoped MCP tools require workflowId and have no workflow pin. Read run_inputs before supplying the fixture INV-104 / 120, so the input keys match the flow you actually found. The complete build is in your first workflow.

In the app: open Workflows, choose Invoice intake, and select Dev to inspect the same development workflow. With an assistant: start with workflow_list with {}. File inputs contain inline content rather than a path on the assistant’s computer.

Read the access and wait fields before running a tool. run_flow can execute real actions in development or live, and an unfinished result needs a follow-up read. Choose the pure Check invoice flow for the first test. A successful MCP response can still describe a failed workflow execution, so inspect data.status and data.finished.

For connection setup, toolset selection, and file delivery, read MCP setup and behavior. Return here when you need a parameter spelling, a required value, or the structure of a result.

This catalog describes backend catalog 072b5da58228, with skill set 89d214d16fbe37ba.

The source snapshot captures all 228 typed tools and 224 data output schema files from the backend operation registry.

“Current” means current with the captured snapshot: --check compares generated Markdown with that snapshot, without checking current product source hashes.

The exact classification covers 177 tools; opaque covers 51 tools whose provider, user, or execution fields can vary. The shared result fields below apply to both.

Required inputs must be present. An em dash under Schema default means the MCP schema advertises no default; consult the description for behavior when omitted. Expand the complete schema for nested object fields and alternative shapes.

The tool list flattens root-level cross-field conditions for host compatibility, but the server still enforces the rules printed with each tool. validJson means the string must parse as JSON; uniqueFieldIds rejects repeated field identifiers.

Runtime input limit Value
Unpatterned strings 32,768 characters, or a smaller schema limit; file-bound root strings use the file ceiling.
Arrays declared in parameter schemas 1,000 items, or a smaller schema limit.
Objects declared in parameter schemas 256 properties, or a smaller schema limit.
File-bound content 2,097,152 UTF-8 bytes (2 MiB).
file_share decoded content 2 MiB; its encoding-specific checks apply separately.

Every tool requires the one OAuth scope, controller:full; the assistant works with your own access.

Annotations describe the tool’s advertised behavior; destructiveHint=false is not a promise that an action has no external effect. For example, run_node has destructiveHint=false and openWorldHint=true, and can execute a real external action.

The output schema applies to structuredContent, with operation-specific results under the required data field. The object also allows additional runtime status fields.

Field Meaning
data Operation result; can be null when a large result is delivered as an artifact.
warnings Non-fatal operation warnings.
events Runtime event objects.
outputArtifact, dataPreview Private result artifact and a bounded preview when inline delivery is too large.
timedOut, outputLimitExceeded Process deadline or output capture limit was reached.
outcomeUnknown, postExecutionError The command may have taken effect; inspect current state before retrying.
data.status, data.finished Async run, conversation, or approval status where supplied; a tool result can describe a failed execution.
Shared result schema; each tool supplies its own data schema
{
"type": "object",
"properties": {
"data": {},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"outputArtifact": {
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"name": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"size": {
"type": "integer"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"uri",
"name",
"mimeType",
"size",
"expiresAt"
],
"additionalProperties": false
},
"dataPreview": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"timedOut": {
"type": "boolean"
},
"outcomeUnknown": {
"type": "boolean"
},
"postExecutionError": {
"type": "string"
}
},
"required": [
"data"
],
"additionalProperties": false
}

Output validation defaults to warning mode: a schema mismatch is logged without changing the result.

Family Tools Read Write
Workflows 24 13 11
Flows 16 3 13
Nodes 19 5 14
Expressions 4 4 0
Branches 6 1 5
Company brain 8 8 0
Schemas 6 3 3
Data 13 5 8
Triggers 15 8 7
Runs 6 2 4
Executions 5 5 0
Integrations 19 9 10
Connections 7 2 5
Agents 38 13 25
Skills 11 4 7
Team 11 4 7
Artifacts 7 3 4
Memory 4 1 3
Labels 2 1 1
Account 5 4 1
Guides 2 2 0

Lists agents and workflows that depend on one workflow or the whole account. Account-wide reads use the lowest workflow id and return routingWorkflowId; an empty account returns an empty result with a warning.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string No — Optional workflow to inspect; omit for the account-wide map.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"const": "account"
},
"agents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"agentId": {
"type": "integer"
},
"name": {
"type": "string"
},
"hasLiveVersion": {
"type": "boolean"
},
"draft": {
"type": "object",
"properties": {
"workflowIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"directActionConnectionIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"workflowIds",
"directActionConnectionIds"
],
"additionalProperties": false
},
"live": {
"oneOf": [
{
"type": "object",
"properties": {
"workflowIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"directActionConnectionIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"workflowIds",
"directActionConnectionIds"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"agentId",
"name",
"hasLiveVersion",
"draft",
"live"
],
"additionalProperties": false
}
},
"workflows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"name": {
"type": "string"
},
"hasLiveVersion": {
"type": "boolean"
},
"draft": {
"type": "object",
"properties": {
"connectionIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"triggerIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"connectionIds",
"triggerIds"
],
"additionalProperties": false
},
"live": {
"oneOf": [
{
"type": "object",
"properties": {
"connectionIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"triggerIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"connectionIds",
"triggerIds"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"workflowId",
"name",
"hasLiveVersion",
"draft",
"live"
],
"additionalProperties": false
}
}
},
"required": [
"scope",
"agents",
"workflows"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"const": "workflow"
},
"workflow": {
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"name": {
"type": "string"
},
"hasLiveVersion": {
"type": "boolean"
}
},
"required": [
"workflowId",
"name",
"hasLiveVersion"
],
"additionalProperties": false
},
"agents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"agentId": {
"type": "integer"
},
"name": {
"type": "string"
},
"hasLiveVersion": {
"type": "boolean"
},
"draftAttachment": {
"type": "boolean"
},
"liveAttachment": {
"type": "boolean"
},
"toolIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"draftToolIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"agentId",
"name",
"hasLiveVersion",
"draftAttachment",
"liveAttachment",
"toolIds",
"draftToolIds"
],
"additionalProperties": false
}
},
"connections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"connectionId": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"draftUsage": {
"type": "boolean"
},
"liveUsage": {
"type": "boolean"
}
},
"required": [
"connectionId",
"name",
"draftUsage",
"liveUsage"
],
"additionalProperties": false
}
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggerId": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"draftEnabled": {
"type": [
"boolean",
"null"
]
},
"liveEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"triggerId",
"name",
"enabled",
"draftEnabled",
"liveEnabled"
],
"additionalProperties": false
}
}
},
"required": [
"scope",
"workflow",
"agents",
"connections",
"triggers"
],
"additionalProperties": false
}
]
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists newest-first account activity across connections, workflows, runs, agents, and members; trigger_event_list instead lists provider events for one trigger. Account-wide reads use the lowest workflow id and return routingWorkflowId; cursors are opaque.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
cursor string No — Opaque cursor for events older than the previous page.
limit integer No — Events per page; defaults to 50 and has a maximum of 200.
minimum: 1; maximum: 200
since string No — Start time as an ISO timestamp or relative duration such as 30m, 2h, or 7d.
type array No [] Account event types to include.
workflowId string No — Optional filter to events about one workflow; omit for the whole account.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"cursor": {
"type": "string"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 200
},
"since": {
"type": "string"
},
"type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"connection.created",
"workflow.created",
"workflow.deleted",
"workflow.updated",
"workflow.published",
"workflow.run",
"agent.created",
"agent.published",
"org.member_added"
]
},
"default": []
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"connection.created",
"workflow.created",
"workflow.deleted",
"workflow.updated",
"workflow.published",
"workflow.run",
"agent.created",
"agent.published",
"org.member_added"
]
},
"at": {
"type": "string",
"format": "date-time"
},
"cursor": {
"type": "string"
},
"summary": {
"type": "string"
},
"workflowId": {
"type": "integer"
},
"agentId": {
"type": "integer"
},
"connectionId": {
"type": "integer"
},
"executionId": {
"type": "integer"
},
"actor": {
"type": "object",
"properties": {
"userId": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"userId",
"name",
"email"
],
"additionalProperties": false
},
"detail": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"type",
"at",
"cursor",
"summary"
],
"additionalProperties": false
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"required": [
"events",
"nextCursor"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Creates a named workflow with a development version. Nothing becomes live until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
name string Yes — Workflow name.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"uniqueName": {
"type": "string"
},
"flowCount": {
"type": "integer",
"minimum": 0
},
"nextStep": {
"type": "string"
}
},
"required": [
"id",
"name",
"uniqueName"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Soft-deletes a workflow; first detach dependent draft and Live agent tools. The delete commits before external trigger teardown, so a teardown error can leave the workflow deleted with manual trigger cleanup still required. There is no public undelete.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint true
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"softDeleted": {
"const": true
},
"triggersTornDown": {
"const": true
},
"result": {
"type": "null"
}
},
"required": [
"workflowId",
"softDeleted",
"triggersTornDown",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

workflow_description_set: Set Workflow Description

Section titled “workflow_description_set: Set Workflow Description”

Sets or clears a workflow description.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
description string Yes — New workflow description; an empty value clears it.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"description",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"userId": {
"type": "integer"
},
"organizationId": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time"
},
"active": {
"type": "boolean"
},
"pausedAt": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"uniqueName": {
"type": "string"
},
"nodeComponents": {
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeSlug": {
"type": "string"
},
"nodeComponentKey": {
"type": "string"
}
},
"required": [
"nodeSlug",
"nodeComponentKey"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"triggers": {
"type": "array",
"items": {
"type": "integer"
}
},
"draftTriggers": {
"type": "array",
"items": {
"type": "integer"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"isDeleted": {
"type": "boolean"
},
"createdByThreadId": {
"type": [
"integer",
"null"
]
},
"visibility": {
"type": "string",
"enum": [
"private",
"organization"
]
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"appUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"userId",
"name",
"description",
"lastUpdatedAt",
"active",
"pausedAt",
"uniqueName",
"nodeComponents",
"triggers",
"draftTriggers",
"createdAt",
"updatedAt",
"isDeleted"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reads the complete opaque workflow JSON; workflow_state_get returns a bounded view; workflow_outline maps compact workflow structure. It uses a requested historical state or defaults to the current development head, and large results can spill to a private output artifact.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
stateId string No — Optional saved state id; omit for the current development head.
pattern: "^[1-9][0-9]*$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"stateId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Copies a workflow with all flows and nodes onto its own unpublished development version. The copy has empty data record stores, so records are not duplicated.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"userId": {
"type": "integer"
},
"organizationId": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time"
},
"active": {
"type": "boolean"
},
"pausedAt": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"uniqueName": {
"type": "string"
},
"nodeComponents": {
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeSlug": {
"type": "string"
},
"nodeComponentKey": {
"type": "string"
}
},
"required": [
"nodeSlug",
"nodeComponentKey"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"triggers": {
"type": "array",
"items": {
"type": "integer"
}
},
"draftTriggers": {
"type": "array",
"items": {
"type": "integer"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"isDeleted": {
"type": "boolean"
},
"createdByThreadId": {
"type": [
"integer",
"null"
]
},
"visibility": {
"type": "string",
"enum": [
"private",
"organization"
]
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"appUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"userId",
"name",
"description",
"lastUpdatedAt",
"active",
"pausedAt",
"uniqueName",
"nodeComponents",
"triggers",
"draftTriggers",
"createdAt",
"updatedAt",
"isDeleted"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reads workflow metadata for its owner; someone it is shared with gets the run view: the shared published flows with inputs and outputs, and their own recent runs. The owner sees that view with view run; workflow_outline maps workflow structure and workflow_status reports readiness.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
view string No — Full (the owner default) or run: the flows, inputs and runs people it is shared with see.
enum: ["full","run"]
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"view": {
"type": "string",
"enum": [
"full",
"run"
]
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"userId": {
"type": "integer"
},
"organizationId": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time"
},
"active": {
"type": "boolean"
},
"pausedAt": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"uniqueName": {
"type": "string"
},
"nodeComponents": {
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeSlug": {
"type": "string"
},
"nodeComponentKey": {
"type": "string"
}
},
"required": [
"nodeSlug",
"nodeComponentKey"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"triggers": {
"type": "array",
"items": {
"type": "integer"
}
},
"draftTriggers": {
"type": "array",
"items": {
"type": "integer"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"isDeleted": {
"type": "boolean"
},
"createdByThreadId": {
"type": [
"integer",
"null"
]
},
"visibility": {
"type": "string",
"enum": [
"private",
"organization"
]
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"appUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"userId",
"name",
"description",
"lastUpdatedAt",
"active",
"pausedAt",
"uniqueName",
"nodeComponents",
"triggers",
"draftTriggers",
"createdAt",
"updatedAt",
"isDeleted"
],
"additionalProperties": false
},
{
"type": "null"
},
{
"type": "object",
"properties": {
"view": {
"type": "string",
"enum": [
"run"
]
},
"workflowId": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner": {
"oneOf": [
{
"type": "string",
"enum": [
"you"
]
},
{
"type": "object",
"properties": {
"userId": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"userId",
"name"
],
"additionalProperties": false
}
]
},
"relation": {
"type": "string",
"enum": [
"owner",
"shared"
]
},
"via": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"person",
"group",
"everyone",
"public_link"
]
},
"name": {
"type": "string"
}
},
"required": [
"kind",
"name"
],
"additionalProperties": false
}
},
"can": {
"type": "array",
"items": {
"type": "string",
"enum": [
"run",
"view",
"edit",
"pause",
"share",
"delete"
]
}
},
"status": {
"type": "string",
"enum": [
"draft",
"live",
"paused"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"appUrl": {
"type": [
"string",
"null"
]
},
"blocked": {
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"fixedBy": {
"type": "string"
},
"fix": {
"type": "object",
"properties": {
"tool": {
"type": "string"
},
"args": {
"type": "object"
}
},
"required": [
"tool",
"args"
],
"additionalProperties": false
}
},
"required": [
"reason",
"fixedBy"
],
"additionalProperties": false
}
]
},
"scope": {
"oneOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "object",
"properties": {
"granted": {
"type": "array",
"items": {
"type": "string"
}
},
"of": {
"type": [
"integer",
"null"
]
}
},
"required": [
"granted",
"of"
],
"additionalProperties": false
}
]
},
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flowId": {
"type": "string"
},
"name": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"enum": {
"type": "array"
},
"default": {}
},
"required": [
"name",
"label",
"type",
"required",
"description"
],
"additionalProperties": false
}
},
"outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type",
"description"
],
"additionalProperties": false
}
}
},
"required": [
"flowId",
"name",
"inputs",
"outputs"
],
"additionalProperties": false
}
},
"yourRecentRuns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"executionId": {
"type": "integer"
},
"flowId": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"startedAt": {
"type": [
"string",
"null"
]
}
},
"required": [
"executionId",
"flowId",
"status",
"startedAt"
],
"additionalProperties": false
}
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"view",
"workflowId",
"name",
"description",
"owner",
"relation",
"via",
"can",
"status",
"publishedAt",
"appUrl",
"blocked",
"scope",
"flows",
"yourRecentRuns",
"next"
],
"additionalProperties": false
}
]
},
{
"type": "null"
}
]
}

Lists saved workflow states, optionally narrowed to a version or expanded group.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
group string No — Saved-state group to expand.
version string No — Positive numeric workflow version id; omit for the development version.
pattern: "^[1-9][0-9]*$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"group": {
"type": "string"
},
"version": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"workflowVersionId": {
"type": "integer"
},
"group": {
"type": [
"string",
"null"
]
},
"history": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "single"
},
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updateReason": {
"type": "string",
"enum": [
"publish",
"edit",
"restore",
"execution"
]
}
},
"required": [
"type",
"id",
"name",
"createdAt",
"updateReason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "group"
},
"groupId": {
"type": "string"
},
"count": {
"type": "integer"
},
"firstCreatedAt": {
"type": "string",
"format": "date-time"
},
"lastCreatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"type",
"groupId",
"count",
"firstCreatedAt",
"lastCreatedAt"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updateReason": {
"type": "string",
"enum": [
"publish",
"edit",
"restore",
"execution"
]
},
"sessionId": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"createdAt",
"updateReason",
"sessionId"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"workflowVersionId",
"group",
"history"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists your workflows and those shared with you or your groups together, usable first, each with its owner, how it reached you, status, blockers and runnable flows. Verbs: run (workflow_run), view (workflow_get), and for your own edit, pause, share and delete. A skill (skill_list) says which flow to run.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
limit integer No 50 Workflows per page; defaults to 50 and has a maximum of 100.
minimum: 1; maximum: 100
query string No — Words in the workflow name or description.
maxLength: 200
relation string No "all" Whose: mine, shared (with you or a group of yours) or all.
enum: ["mine","shared","all"]
cursor string No — The nextCursor of the previous page.
maxLength: 200
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"query": {
"type": "string",
"maxLength": 200
},
"relation": {
"type": "string",
"enum": [
"mine",
"shared",
"all"
],
"default": "all"
},
"cursor": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"name": {
"type": "string"
},
"summary": {
"type": "string",
"maxLength": 100
},
"owner": {
"oneOf": [
{
"type": "string",
"enum": [
"you"
]
},
{
"type": "object",
"properties": {
"userId": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"userId",
"name"
],
"additionalProperties": false
}
]
},
"relation": {
"type": "string",
"enum": [
"owner",
"shared"
]
},
"via": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"person",
"group",
"everyone",
"public_link"
]
},
"name": {
"type": "string"
}
},
"required": [
"kind",
"name"
],
"additionalProperties": false
}
},
"can": {
"type": "array",
"items": {
"type": "string",
"enum": [
"run",
"view",
"edit",
"pause",
"share",
"delete"
]
}
},
"status": {
"type": "string",
"enum": [
"draft",
"live",
"paused"
]
},
"blocked": {
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"fixedBy": {
"type": "string"
},
"fix": {
"type": "object",
"properties": {
"tool": {
"type": "string"
},
"args": {
"type": "object"
}
},
"required": [
"tool",
"args"
],
"additionalProperties": false
}
},
"required": [
"reason",
"fixedBy"
],
"additionalProperties": false
}
]
},
"scope": {
"oneOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "object",
"properties": {
"granted": {
"type": "array",
"items": {
"type": "string"
}
},
"of": {
"type": [
"integer",
"null"
]
}
},
"required": [
"granted",
"of"
],
"additionalProperties": false
}
]
},
"updatedAt": {
"type": [
"string",
"null"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flowId": {
"type": "string"
},
"name": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"flowId",
"name",
"inputs"
],
"additionalProperties": false
}
},
"moreFlows": {
"type": "integer",
"minimum": 0
},
"appUrl": {
"type": [
"string",
"null"
]
}
},
"required": [
"workflowId",
"name",
"summary",
"owner",
"relation",
"via",
"can",
"status",
"blocked",
"scope",
"updatedAt",
"publishedAt",
"flows",
"moreFlows",
"appUrl"
],
"additionalProperties": false
}
},
"total": {
"type": "integer",
"minimum": 0
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"verbs": {
"type": "object",
"properties": {
"run": {
"type": "string"
},
"view": {
"type": "string"
},
"edit": {
"type": "string"
},
"pause": {
"type": "string"
},
"share": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"items",
"total",
"nextCursor",
"verbs"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}

Maps compact development topology across flows, nodes, triggers, and data types, optionally for one flowId; workflow_get returns metadata and workflow_status reports readiness.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
flowId string No — Optional flow id; limits flows to that flow and triggers to those that start it.
minLength: 1
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"flowId": {
"type": "string",
"minLength": 1
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"active": {
"type": [
"boolean",
"null"
]
},
"hasLiveVersion": {
"type": [
"boolean",
"null"
]
},
"liveMatchesDev": {
"type": [
"boolean",
"null"
]
},
"needsPublish": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"name",
"active",
"hasLiveVersion",
"liveMatchesDev",
"needsPublish"
],
"additionalProperties": false
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"source": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"testEventsArmed": {
"type": "boolean"
},
"flowId": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"source",
"enabled",
"testEventsArmed",
"flowId"
],
"additionalProperties": false
}
},
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"bindingsUnavailable": {
"const": true
},
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"binding": {
"type": [
"string",
"null"
]
},
"display": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"optional": {
"const": true
}
},
"required": [
"name",
"binding",
"display",
"type"
],
"additionalProperties": false
}
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"component": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"deps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"name",
"component",
"type",
"deps"
],
"additionalProperties": false
}
},
"outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"binding": {
"type": [
"string",
"null"
]
},
"display": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"optional": {
"const": true
}
},
"required": [
"binding",
"display",
"type"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"inputs",
"nodes",
"outputs"
],
"additionalProperties": false
}
},
"dataTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"fieldCount": {
"type": [
"integer",
"null"
]
},
"derived": {
"const": true
},
"records": {
"type": "object",
"properties": {
"dev": {
"type": [
"integer",
"null"
]
},
"live": {
"type": [
"integer",
"null"
]
}
},
"required": [
"dev",
"live"
],
"additionalProperties": false
}
},
"required": [
"key",
"name",
"fieldCount",
"records"
],
"additionalProperties": false
}
}
},
"required": [
"workflow",
"triggers",
"flows",
"dataTypes"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Publishes the development definition and schemas, activates enabled Live triggers, and refreshes following Live agent conversations. Development records are never copied. Attached agent workflow tools follow the new release without an agent republish. Inspect returned warnings: a failed session refresh leaves affected sessions using the previous release until they restart. Publication acknowledgements remain required.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint false
openWorldHint true
Input Type Required Schema default Meaning and constraints
acknowledgeDualDispatch boolean No — Acknowledges that armed test events can dispatch one real event on both development and live versions.
acknowledgeValidationErrors boolean No — Acknowledges publishing despite the reported validation errors.
name string No — Release name.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"acknowledgeDualDispatch": {
"type": "boolean"
},
"acknowledgeValidationErrors": {
"type": "boolean"
},
"name": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"published": {
"const": true
},
"active": {
"const": true
},
"flowCount": {
"type": "integer"
},
"enabledTriggerCount": {
"type": "integer"
},
"warnings": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"code": {
"type": "string",
"const": "agent_workflow_interface_changed"
},
"message": {
"type": "string"
},
"affectedAgentCount": {
"type": "integer"
}
},
"required": [
"code",
"message",
"affectedAgentCount"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"const": "trigger_test_events_active"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"additionalProperties": false
}
]
}
},
"note": {
"type": "string"
},
"headStateId": {
"type": [
"integer",
"null"
]
},
"appUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"published",
"active",
"flowCount",
"enabledTriggerCount",
"warnings",
"note",
"headStateId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"published": {
"const": false
},
"pending": {
"const": true
},
"workflowId": {
"type": "integer"
},
"startedAt": {
"type": "string",
"format": "date-time"
},
"note": {
"type": "string"
}
},
"required": [
"published",
"pending",
"workflowId",
"startedAt",
"note"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

workflow_release_list: Workflow Release List

Section titled “workflow_release_list: Workflow Release List”

Lists published workflow release checkpoints.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"versionNumber": {
"type": "integer"
},
"workflowVersionStateId": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"versionNumber",
"workflowVersionStateId",
"createdAt"
],
"additionalProperties": false
}
}
},
"required": [
"workflowId",
"releases"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Renames one workflow.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
name string Yes — New workflow name.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"name",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"userId": {
"type": "integer"
},
"organizationId": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time"
},
"active": {
"type": "boolean"
},
"pausedAt": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"uniqueName": {
"type": "string"
},
"nodeComponents": {
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeSlug": {
"type": "string"
},
"nodeComponentKey": {
"type": "string"
}
},
"required": [
"nodeSlug",
"nodeComponentKey"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"triggers": {
"type": "array",
"items": {
"type": "integer"
}
},
"draftTriggers": {
"type": "array",
"items": {
"type": "integer"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"isDeleted": {
"type": "boolean"
},
"createdByThreadId": {
"type": [
"integer",
"null"
]
},
"visibility": {
"type": "string",
"enum": [
"private",
"organization"
]
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"appUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"userId",
"name",
"description",
"lastUpdatedAt",
"active",
"pausedAt",
"uniqueName",
"nodeComponents",
"triggers",
"draftTriggers",
"createdAt",
"updatedAt",
"isDeleted"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

workflow_set_paused: Pause or resume workflow

Section titled “workflow_set_paused: Pause or resume workflow”

Pause or resume one workflow. While paused, its live version starts no new runs: trigger events are still recorded but run nothing, and agent tool calls and live API runs are refused. Runs already started finish, development runs still work, and publishing does not resume it.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
paused boolean Yes — True pauses the workflow; false resumes it.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"paused": {
"type": "boolean"
}
},
"required": [
"workflowId",
"paused"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"paused": {
"type": "boolean"
},
"pausedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"changed": {
"type": "boolean"
}
},
"required": [
"workflowId",
"paused",
"pausedAt",
"changed"
],
"additionalProperties": false
}

Reads who a workflow is shared with: people, groups and other members’ agents, each for all flows or chosen ones. Also lists the published flows and the agents it could be shared with.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id; only its owner manages its sharing.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"published": {
"type": "boolean"
},
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flowId": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"flowId",
"name"
],
"additionalProperties": false
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shareId": {
"type": "integer"
},
"principalType": {
"type": "string",
"enum": [
"user",
"group",
"agent"
]
},
"principalId": {
"type": "integer"
},
"name": {
"type": "string"
},
"flows": {
"oneOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"required": [
"shareId",
"principalType",
"principalId",
"name",
"flows"
],
"additionalProperties": false
}
},
"agents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"agentId": {
"type": "integer"
},
"name": {
"type": "string"
},
"ownerName": {
"type": "string"
}
},
"required": [
"agentId",
"name",
"ownerName"
],
"additionalProperties": false
}
}
},
"required": [
"workflowId",
"published",
"flows",
"shares",
"agents"
],
"additionalProperties": false
}

workflow_share_remove: Remove workflow share

Section titled “workflow_share_remove: Remove workflow share”

Removes one share from a workflow; agent tools that relied on it stop running the workflow’s flows at once.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id; only its owner manages its sharing.
pattern: "^[1-9][0-9]*$"
shareId integer Yes — Share id, from workflow_share_get.
minimum: 1
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"shareId": {
"type": "integer",
"minimum": 1
}
},
"required": [
"workflowId",
"shareId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"published": {
"type": "boolean"
},
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flowId": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"flowId",
"name"
],
"additionalProperties": false
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shareId": {
"type": "integer"
},
"principalType": {
"type": "string",
"enum": [
"user",
"group",
"agent"
]
},
"principalId": {
"type": "integer"
},
"name": {
"type": "string"
},
"flows": {
"oneOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"required": [
"shareId",
"principalType",
"principalId",
"name",
"flows"
],
"additionalProperties": false
}
},
"agents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"agentId": {
"type": "integer"
},
"name": {
"type": "string"
},
"ownerName": {
"type": "string"
}
},
"required": [
"agentId",
"name",
"ownerName"
],
"additionalProperties": false
}
}
},
"required": [
"workflowId",
"published",
"flows",
"shares",
"agents"
],
"additionalProperties": false
}

Shares a published workflow with a person, a group or an agent, so they can add its flows as agent tools; repeating it for the same principal changes which flows they get. Shared flows always run their published release as the owner.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id; only its owner manages its sharing.
pattern: "^[1-9][0-9]*$"
principalType string Yes — Who receives the share: a workspace member, a group, or an agent.
enum: ["user","group","agent"]
principalId integer Yes — User id from member_list, group id from group_list, or agent id.
minimum: 1
flowIds array No — Flow ids to share; omitted, every published flow is shared.
minItems: 1
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"principalType": {
"type": "string",
"enum": [
"user",
"group",
"agent"
]
},
"principalId": {
"type": "integer",
"minimum": 1
},
"flowIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
}
},
"required": [
"workflowId",
"principalType",
"principalId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"published": {
"type": "boolean"
},
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flowId": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"flowId",
"name"
],
"additionalProperties": false
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shareId": {
"type": "integer"
},
"principalType": {
"type": "string",
"enum": [
"user",
"group",
"agent"
]
},
"principalId": {
"type": "integer"
},
"name": {
"type": "string"
},
"flows": {
"oneOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"required": [
"shareId",
"principalType",
"principalId",
"name",
"flows"
],
"additionalProperties": false
}
},
"agents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"agentId": {
"type": "integer"
},
"name": {
"type": "string"
},
"ownerName": {
"type": "string"
}
},
"required": [
"agentId",
"name",
"ownerName"
],
"additionalProperties": false
}
}
},
"required": [
"workflowId",
"published",
"flows",
"shares",
"agents"
],
"additionalProperties": false
}

Reads bounded workflow state and optional per-flow detail; workflow_document_get returns complete JSON; workflow_outline maps compact workflow structure. It uses a requested historical state or defaults to the current development head, and excludes property values and expressions available from node_prop_list or flow_get.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string No — Optional flow id whose bounded node and edge detail is included.
minLength: 1
stateId string No — Optional saved state id; omit for the current development head.
pattern: "^[1-9][0-9]*$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"stateId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"stateId": {
"type": "integer",
"minimum": 1
},
"versionId": {
"type": "integer",
"minimum": 1
},
"workflowId": {
"type": "integer",
"minimum": 1
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"state": {
"type": "string",
"enum": [
"head",
"historical"
]
},
"counts": {
"type": "object",
"properties": {
"flows": {
"type": "integer",
"minimum": 0
},
"nodes": {
"type": "integer",
"minimum": 0
},
"edges": {
"type": "integer",
"minimum": 0
},
"inputs": {
"type": "integer",
"minimum": 0
},
"outputs": {
"type": "integer",
"minimum": 0
},
"triggers": {
"type": "integer",
"minimum": 0
},
"customTypes": {
"type": "integer",
"minimum": 0
}
},
"required": [
"flows",
"nodes",
"edges",
"inputs",
"outputs",
"triggers",
"customTypes"
],
"additionalProperties": false
},
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flowId": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": "integer",
"minimum": 0
},
"edgeCount": {
"type": "integer",
"minimum": 0
},
"inputNames": {
"type": "array",
"items": {
"type": "string"
}
},
"outputNames": {
"type": "array",
"items": {
"type": "string"
}
},
"triggerNames": {
"type": "array",
"items": {
"type": "string"
}
},
"customTypeNames": {
"type": "array",
"items": {
"type": "string"
}
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"key": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"connectionBound": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"key",
"slug",
"connectionBound"
],
"additionalProperties": false
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"output": {
"type": [
"string",
"null"
]
}
},
"required": [
"source",
"target",
"output"
],
"additionalProperties": false
}
}
},
"required": [
"flowId",
"name",
"nodeCount",
"edgeCount",
"inputNames",
"outputNames",
"triggerNames",
"customTypeNames"
],
"additionalProperties": false
}
}
},
"required": [
"stateId",
"versionId",
"workflowId",
"updatedAt",
"state",
"counts",
"flows"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

workflow_state_restore: Workflow State Restoration

Section titled “workflow_state_restore: Workflow State Restoration”

Copies a restorable saved definition into a new development head; newer states remain in history. A listed state can be outside the plan’s restore window. Live, stored records, and external effects remain unchanged; enabled triggers continue invoking the current live release until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
stateId string Yes — Saved state id returned by workflow_history.
pattern: "^[1-9][0-9]*$"
version string No — Positive numeric workflow version id; omit for the development version.
pattern: "^[1-9][0-9]*$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"stateId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"version": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"stateId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"workflowVersionId": {
"type": "integer"
},
"restoredFrom": {
"type": "integer"
},
"headStateId": {
"type": [
"integer",
"null"
]
},
"result": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"userId": {
"type": "integer"
},
"workflowId": {
"type": "integer"
},
"workflowVersionId": {
"type": "integer"
},
"json": {
"type": "string"
},
"flowTypeSchemas": {
"type": [
"string",
"null"
]
},
"updateReason": {
"type": "string",
"enum": [
"publish",
"edit",
"restore",
"execution"
]
},
"affectsLatestState": {
"type": "boolean"
},
"restoredFromStateId": {
"type": [
"integer",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"sessionId": {
"type": [
"string",
"null"
]
},
"createdByUserId": {
"type": [
"integer",
"null"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"userId",
"workflowId",
"workflowVersionId",
"json",
"flowTypeSchemas",
"updateReason",
"affectsLatestState",
"restoredFromStateId",
"name",
"sessionId",
"createdByUserId",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"workflowId",
"workflowVersionId",
"restoredFrom",
"headStateId",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

workflow_state_save: Workflow State Snapshot

Section titled “workflow_state_save: Workflow State Snapshot”

Saves a named development snapshot for later restoration and returns its metadata (stateId, workflowVersionId, createdAt), not the snapshot JSON; workflow_document_get reads the document.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
name string Yes — Snapshot name.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"name",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"name": {
"type": "string"
},
"stateId": {
"type": [
"integer",
"null"
]
},
"headStateId": {
"type": [
"integer",
"null"
]
},
"workflowVersionId": {
"type": [
"integer",
"null"
]
},
"createdAt": {
"type": [
"string",
"null"
]
}
},
"required": [
"workflowId",
"name",
"stateId",
"headStateId",
"workflowVersionId",
"createdAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reports whether development is ahead of live and whether triggers are ready; workflow_get returns metadata and workflow_outline maps workflow structure.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"paused": {
"type": "boolean"
},
"hasLiveVersion": {
"type": "boolean"
},
"liveMatchesDev": {
"type": "boolean"
},
"needsPublish": {
"type": "boolean"
},
"lastPublishedAt": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"lastDevChangeAt": {
"type": "string",
"format": "date-time"
},
"flowCount": {
"type": "integer"
},
"triggerCount": {
"type": "integer"
},
"enabledTriggerCount": {
"type": "integer"
},
"devDispatchArmedTriggerCount": {
"type": "integer"
},
"validation": {
"oneOf": [
{
"type": "object",
"properties": {
"errors": {
"type": "integer"
},
"warnings": {
"type": "integer"
},
"redNodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"displayName": {
"type": "string"
},
"codes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"nodeId",
"displayName",
"codes"
],
"additionalProperties": false
}
}
},
"required": [
"errors",
"warnings",
"redNodes"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"unavailable": {
"const": true
}
},
"required": [
"unavailable"
],
"additionalProperties": false
}
]
},
"note": {
"type": "string"
},
"appUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"active",
"paused",
"hasLiveVersion",
"liveMatchesDev",
"needsPublish",
"lastPublishedAt",
"lastDevChangeAt",
"flowCount",
"triggerCount",
"enabledTriggerCount",
"devDispatchArmedTriggerCount",
"validation",
"note"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Validates the development workflow’s properties, connections, wiring, expressions, types, subflows, branches, and triggers. The result leads with a compact summary (errorCount, warningCount, one-line errors with flow and node names); severity and flowId narrow the listed issues.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
severity string No "all" Which issues and nodes to list: error, warning, or all (the default); summary always lists errors.
enum: ["error","warning","all"]
flowId string No — Optional flow id limiting issues, nodes, and summary counts; valid still covers the whole workflow.
minLength: 1
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"severity": {
"type": "string",
"enum": [
"error",
"warning",
"all"
],
"default": "all"
},
"flowId": {
"type": "string",
"minLength": 1
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"errorCount": {
"type": "integer"
},
"warningCount": {
"type": "integer"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flowId": {
"type": [
"string",
"null"
]
},
"flowName": {
"type": [
"string",
"null"
]
},
"triggerId": {
"type": "string"
},
"nodeId": {
"type": [
"string",
"null"
]
},
"nodeName": {
"type": [
"string",
"null"
]
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"flowId",
"flowName",
"nodeId",
"nodeName",
"code",
"message"
],
"additionalProperties": false
}
},
"omittedErrors": {
"type": "integer"
}
},
"required": [
"errorCount",
"warningCount",
"errors"
],
"additionalProperties": false
},
"valid": {
"type": "boolean"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"severity": {
"type": "string",
"enum": [
"error",
"warning"
]
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"flowId": {
"type": "string"
},
"nodeId": {
"type": "string"
},
"triggerId": {
"type": "string"
},
"path": {
"type": "string"
},
"propName": {
"type": "string"
},
"inputId": {
"type": "string"
},
"outputId": {
"type": "string"
},
"connectionId": {
"type": "string"
},
"nodeDisplayName": {
"type": "string"
},
"referenceId": {
"type": "string"
},
"referenceKind": {
"type": "string",
"enum": [
"flow_input",
"node_input"
]
},
"fix": {
"type": "string"
}
},
"required": [
"severity",
"code",
"message"
],
"additionalProperties": false
}
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"flowId": {
"type": "string"
},
"triggerId": {
"type": "string"
},
"displayName": {
"type": "string"
},
"errors": {
"type": "integer"
},
"warnings": {
"type": "integer"
},
"codes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"nodeId",
"displayName",
"errors",
"warnings",
"codes"
],
"additionalProperties": false
}
},
"issuesTruncated": {
"const": true
}
},
"required": [
"summary",
"valid",
"issues",
"nodes"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

workflow_version_list: Workflow Version List

Section titled “workflow_version_list: Workflow Version List”

Lists the development version and live release for one workflow.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"workflowId": {
"type": "integer"
},
"versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"workflowId": {
"type": "integer"
},
"userId": {
"type": "integer"
},
"name": {
"type": "string"
},
"isLiveVersion": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"workflowId",
"userId",
"name",
"isLiveVersion",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"workflowId",
"versions"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Creates a flow canvas on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
name string Yes — Flow name.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"name",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"flowId": {
"type": "string"
},
"name": {
"type": "string"
},
"order": {
"type": "integer"
}
},
"required": [
"success",
"flowId",
"name",
"order"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Deletes the development flow and its triggers, clears Run Subflow references, and can break attached agent tools. Inspect the returned dependency warning; it does not block deletion. Live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Copies a flow with fresh ids for every node and edge on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"newFlowId": {
"type": "string"
}
},
"required": [
"success",
"newFlowId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Creates the core for-each scaffold atomically on the development version. Optional maxItems is enabled, set, and read back through later calls that can fail after the loop exists; inspect the workflow graph before retrying. Live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
continueOnError boolean No — Whether each iteration continues after an error.
flow string Yes — Parent flow containing the list-producing node.
from string No — Source node id; exactly one of listJs or from with sourceOutput is required.
minLength: 1
itemField array No — Field for a new custom item type; omit for existing types, and primitive itemType values cannot include it.
minItems: 1
itemName string No — Display name for the item flow input.
itemType string Yes — Item type: text, number, date, boolean, an existing or new custom.* type, or a dataRecord.custom.* record; primitive types cannot include itemField.
listField string No — Nested field forming inputs.<binding>.data; requires from and sourceOutput and cannot be combined with listJs.
listJs string No — JavaScript list selector; exactly one of listJs or from with sourceOutput is required, and listField is unavailable.
minLength: 1; maxLength: 1048576
maxItems integer No — Runtime list limit; defaults to 500 and has a maximum of 10000.
minimum: 1; maximum: 10000
name string Yes — Name for the new per-item flow.
sourceOutput string No — Source output id returned by node_get; provide it with from.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Requires exactly one source mode: listJs or from with sourceOutput.
  • from and sourceOutput must be provided together.
  • listField requires from and sourceOutput.
  • listJs and listField are mutually exclusive.
  • A primitive itemType cannot define itemField.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"continueOnError": {
"type": "boolean"
},
"flow": {
"type": "string"
},
"from": {
"type": "string",
"minLength": 1
},
"itemField": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 3
}
},
"itemName": {
"type": "string"
},
"itemType": {
"type": "string"
},
"listField": {
"type": "string"
},
"listJs": {
"type": "string",
"minLength": 1,
"maxLength": 1048576
},
"maxItems": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"name": {
"type": "string"
},
"sourceOutput": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flow",
"itemType",
"name",
"workflowId"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"listJs": {}
},
"required": [
"listJs"
]
},
{
"properties": {
"from": {}
},
"required": [
"from"
]
}
]
},
{
"if": {
"properties": {
"from": {}
},
"required": [
"from"
]
},
"then": {
"properties": {
"sourceOutput": {}
},
"required": [
"sourceOutput"
]
}
},
{
"if": {
"properties": {
"sourceOutput": {}
},
"required": [
"sourceOutput"
]
},
"then": {
"properties": {
"from": {}
},
"required": [
"from"
]
}
},
{
"if": {
"properties": {
"listField": {}
},
"required": [
"listField"
]
},
"then": {
"properties": {
"from": {},
"sourceOutput": {}
},
"required": [
"from",
"sourceOutput"
]
}
},
{
"not": {
"anyOf": [
{
"properties": {
"listJs": {},
"listField": {}
},
"required": [
"listJs",
"listField"
]
}
]
}
},
{
"if": {
"properties": {
"itemType": {
"type": "string",
"pattern": "^[^.]+$"
}
},
"required": [
"itemType"
]
},
"then": {
"not": {
"properties": {
"itemField": {}
},
"required": [
"itemField"
]
}
}
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"bodyFlowId": {
"type": "string"
},
"bodyFlowName": {
"type": "string"
},
"loopNodeId": {
"type": "string"
},
"dataTypeName": {
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"listWiring": {
"type": "object",
"properties": {
"edgeId": {
"type": "string"
},
"nodeInputId": {
"type": "string"
},
"listExpressionJs": {
"type": "string"
}
},
"required": [
"listExpressionJs"
],
"additionalProperties": false
},
"itemFlowInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"jsBinding": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"jsBinding"
],
"additionalProperties": false
},
"extraFlowInputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"bound": {
"type": "boolean"
},
"jsBinding": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"bound",
"jsBinding"
],
"additionalProperties": false
}
},
"nextSteps": {
"type": "array",
"items": {
"type": "string"
}
},
"maxItems": {
"type": "integer"
},
"maxItemsConfigured": {
"type": "boolean"
}
},
"required": [
"success",
"bodyFlowId",
"bodyFlowName",
"loopNodeId",
"dataTypeName",
"listWiring",
"itemFlowInput",
"extraFlowInputs",
"nextSteps",
"maxItems",
"maxItemsConfigured"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reads one development flow with its nodes, edges, and inputs.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"order": {
"type": "integer"
},
"flowInputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"jsBinding": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"displayName": {
"type": "string"
},
"dataType": {
"type": "string"
},
"isList": {
"type": "boolean"
},
"optional": {
"type": "boolean"
},
"testValue": {},
"defaultValue": {}
},
"required": [
"id",
"jsBinding",
"name",
"displayName",
"dataType",
"isList",
"optional",
"testValue"
],
"additionalProperties": false
}
},
"flowOutputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"dataType": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"dataType",
"description"
],
"additionalProperties": false
}
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"displayName": {
"type": "string"
},
"nodeSlug": {
"type": "string"
},
"key": {
"type": "string"
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
"width": {
"type": "number"
},
"estimatedHeight": {
"type": "number"
}
},
"required": [
"id",
"displayName",
"nodeSlug",
"key",
"position",
"width",
"estimatedHeight"
],
"additionalProperties": false
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"sourceHandle": {
"type": [
"string",
"null"
]
},
"branchId": {
"type": "string"
}
},
"required": [
"id",
"source",
"target"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"order",
"flowInputs",
"flowOutputs",
"nodes",
"edges"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Adds a declared input to one flow on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
description string No — Input description.
display string Yes — Human label used to derive the compiler-current input binding.
minLength: 1
list boolean No — Whether the input contains a list of values of the selected type.
optional boolean No — Whether the input is optional.
type string Yes — Input data type, for example text, number, or custom.invoice.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
},
"list": {
"type": "boolean"
},
"optional": {
"type": "boolean"
},
"type": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"display",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"flowInputId": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"displayName": {
"type": "string"
},
"jsBinding": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"displayName",
"jsBinding"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Deletes a declared input from one flow on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
input string Yes — Flow input id.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"input": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"input",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Updates fields on a declared flow input. Unlike node_prop_set, it changes the flow interface rather than action-node configuration; the change stays on the development version until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
defaultValue object | array | string | number | boolean | null No — Stored default parsed as JSON when valid or kept as text; omitted optional inputs resolve to null.
description string No — New input description.
minLength: 1
display string No — New human label, which recomputes jsBinding while legacyBinding remains diagnostic.
minLength: 1
input string Yes — Flow input id; provide at least one input field to update.
name string No — Legacy human-label alias; like display, it recomputes jsBinding rather than setting a stable binding name.
minLength: 1
optional boolean No — Desired optionality, including an explicit required state.
type string No — New input data type.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Requires at least one flow-input field to change.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"defaultValue": {
"oneOf": [
{
"type": "object"
},
{
"type": "array"
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"display": {
"type": "string",
"minLength": 1
},
"input": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"optional": {
"type": "boolean"
},
"type": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"input",
"workflowId"
],
"allOf": [
{
"anyOf": [
{
"properties": {
"name": {}
},
"required": [
"name"
]
},
{
"properties": {
"display": {}
},
"required": [
"display"
]
},
{
"properties": {
"type": {}
},
"required": [
"type"
]
},
{
"properties": {},
"required": [
"description"
]
},
{
"properties": {
"optional": {}
},
"required": [
"optional"
]
},
{
"properties": {
"defaultValue": {}
},
"required": [
"defaultValue"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"flowInputId": {
"type": "string"
},
"flowInput": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"jsBinding": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"displayName": {
"type": "string"
},
"dataType": {
"type": "string"
},
"isList": {
"type": "boolean"
},
"optional": {
"type": "boolean"
},
"testValue": {},
"defaultValue": {}
},
"required": [
"id",
"jsBinding",
"displayName",
"dataType",
"isList",
"optional",
"testValue"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"jsBinding": {
"type": [
"string",
"null"
]
}
},
"required": [
"flowInputId",
"flowInput",
"jsBinding"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Arranges one development flow’s nodes into a readable canvas layout; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"flowId": {
"type": "string"
},
"movedNodes": {
"type": "integer"
},
"changed": {
"type": "boolean"
}
},
"required": [
"success",
"flowId",
"movedNodes",
"changed"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists development flows in the selected workflow.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"order": {
"type": "integer"
},
"nodeCount": {
"type": "integer"
},
"edgeCount": {
"type": "integer"
},
"flowInputCount": {
"type": "integer"
}
},
"required": [
"id",
"name",
"order",
"nodeCount",
"edgeCount",
"flowInputCount"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Adds a declared output to one flow on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
description string No — Output description.
display string Yes — Human-readable output label.
name string No — Stable output binding name.
type string Yes — Output data type, for example text, list.text, or custom.invoice.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"display",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"flowOutputId": {
"type": "string"
}
},
"required": [
"success",
"flowOutputId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Deletes a declared flow output and its matching Return response property from the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
output string Yes — Flow output id.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"output": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"output",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists declared outputs for one development flow.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"flowId": {
"type": "string"
},
"flowName": {
"type": "string"
},
"outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"dataType": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"dataType",
"description"
],
"additionalProperties": false
}
}
},
"required": [
"flowId",
"flowName",
"outputs"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Updates fields on a declared flow output on the development version and keeps its Return response property synchronized; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
description string No — New output description.
display string No — New human-readable output label.
name string No — New stable output binding name.
output string Yes — Flow output id; provide at least one output field to update.
type string No — New output data type.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Requires at least one flow-output field to change.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string"
},
"name": {
"type": "string"
},
"output": {
"type": "string"
},
"type": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"output",
"workflowId"
],
"allOf": [
{
"anyOf": [
{
"properties": {
"name": {}
},
"required": [
"name"
]
},
{
"properties": {
"display": {}
},
"required": [
"display"
]
},
{
"properties": {
"type": {}
},
"required": [
"type"
]
},
{
"properties": {},
"required": [
"description"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"dataType": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"dataType",
"description"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"success": {
"const": true,
"type": "boolean"
}
},
"required": [
"success"
],
"additionalProperties": false
}
]
},
{
"type": "null"
}
]
}

Renames one flow on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
flowId string Yes — Opaque flow id in the selected workflow.
minLength: 1
name string Yes — New flow name.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flowId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flowId",
"name",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reorders development flows for presentation without changing their execution order; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
order array Yes — Every flow id in the desired presentation order.
minItems: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"order": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1
}
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"order",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"flowIds": {
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
}
},
"required": [
"flowIds",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Adds one discovered integration action to a flow; integration_search finds slugs and integration_action_list returns slug-key pairs. For a Router or If/Else in after, afterBranch wires that branch to the new node like branch_connect, keeping existing edges; the node stays in development until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
after string No — Upstream node id to wire from; a Router or If/Else also needs afterBranch; omit for the first node of an empty flow.
minLength: 1
connection integer No — Connection id.
minimum: 1
enableProp array No — Optional property names to enable at creation.
minItems: 1
flow string Yes — Flow id.
key string Yes — Exact action key paired with the integration by integration_action_list.
name string No — Node display name and outgoing connection label.
node string No — Exact integration slug returned with the action key by integration_action_list; inferred from the key when omitted.
output string No "main" Output channel of after to wire from; ignored when after is omitted or afterBranch is set.
enum: ["main","error"]
props object No — Initial property map; direct values become {value:…}, while advanced per-property writes pass through.
additionalProperties: true
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
afterBranch string No — Route or branch id of the Router or If/Else in after, from branch_list; that branch is wired to the new node and any existing branch edge is kept.
minLength: 1

Rules checked together:

  • afterBranch requires after (the Router or If/Else node id).
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"after": {
"type": "string",
"minLength": 1
},
"connection": {
"type": "integer",
"minimum": 1
},
"enableProp": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1
}
},
"flow": {
"type": "string"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"node": {
"type": "string"
},
"output": {
"type": "string",
"enum": [
"main",
"error"
],
"default": "main"
},
"props": {
"type": "object",
"additionalProperties": true
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"afterBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"flow",
"key",
"workflowId"
],
"allOf": [
{
"if": {
"properties": {
"afterBranch": {}
},
"required": [
"afterBranch"
]
},
"then": {
"properties": {
"after": {}
},
"required": [
"after"
]
}
}
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"nodeId": {
"type": "string"
},
"displayName": {
"type": "string"
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
"propsSet": {
"type": "array",
"items": {
"type": "string"
}
},
"dependentPropsMaterialized": {
"type": "array",
"items": {
"type": "string"
}
},
"normalizedProps": {
"type": "object",
"additionalProperties": true
},
"propsReadback": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string"
},
"displayName": {
"type": "string"
},
"inputType": {
"type": "string"
},
"required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"value": {},
"valueJs": {},
"valueItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"valueJs": {
"type": [
"string",
"null"
]
}
},
"required": [
"index",
"valueJs"
],
"additionalProperties": true
}
},
"valueItemsTruncated": {
"type": "object",
"properties": {
"returned": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"returned",
"total"
],
"additionalProperties": false
},
"expressionValue": {},
"expressionValueJs": {},
"allowsExpressionMode": {
"type": "boolean"
},
"hasDynamicExpression": {
"type": "boolean"
},
"remoteOptions": {
"type": "boolean"
},
"reloadProps": {
"type": "boolean"
},
"optionsAvailability": {
"type": "string",
"enum": [
"available",
"blocked_upstream",
"dynamic_upstream"
]
},
"blockedBy": {
"type": [
"string",
"null"
]
},
"optionsIndependent": {
"type": "boolean"
},
"withLabel": {
"type": "boolean"
},
"source": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"readiness": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"requireAuth": {
"type": "boolean"
},
"connectionId": {
"type": [
"string",
"null"
]
},
"missingConnection": {
"type": "boolean"
},
"missingRequiredProps": {
"type": "array",
"items": {
"type": "string"
}
},
"disabledRequiredProps": {
"type": "array",
"items": {
"type": "string"
}
},
"pendingReloadProps": {
"type": "array",
"items": {
"type": "string"
}
},
"dynamicSelectorNotes": {
"type": "array",
"items": {
"type": "string"
}
},
"readinessState": {
"type": "string",
"enum": [
"ready",
"blocked",
"indeterminate"
]
},
"outputTypeStatus": {
"type": "string",
"enum": [
"concrete",
"unresolved",
"none"
]
},
"outputTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"outputPortTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"outputTypeSource": {
"type": "string",
"enum": [
"processOutput",
"component",
"port-wrapper",
"none"
]
},
"readyForExpressions": {
"type": "boolean"
},
"readyForRun": {
"type": "boolean"
},
"readyForDownstreamExpressions": {
"type": "boolean"
},
"blockedBy": {
"type": "array",
"items": {
"type": "string"
}
},
"next": {
"type": "string"
}
},
"required": [
"nodeId",
"requireAuth",
"connectionId",
"missingConnection",
"missingRequiredProps",
"disabledRequiredProps",
"pendingReloadProps",
"dynamicSelectorNotes",
"readinessState",
"outputTypeStatus",
"outputTypes",
"outputPortTypes",
"outputTypeSource",
"readyForExpressions",
"readyForRun",
"readyForDownstreamExpressions",
"blockedBy",
"next"
],
"additionalProperties": false
}
},
"required": [
"nodeId",
"normalizedProps",
"propsReadback",
"readiness"
],
"additionalProperties": true
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Connects two development nodes and wires the selected source output into the target; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
flow string Yes — Flow id.
from string Yes — Upstream node id.
output string No "main" Source output channel to wire.
enum: ["main","error"]
to string Yes — Downstream node id.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"flow": {
"type": "string"
},
"from": {
"type": "string"
},
"output": {
"type": "string",
"enum": [
"main",
"error"
],
"default": "main"
},
"to": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"flow",
"from",
"to",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"edgeId": {
"type": "string"
},
"nodeInputId": {
"type": "string"
}
},
"required": [
"success",
"edgeId",
"nodeInputId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

node_connection_set: Node Connection Binding

Section titled “node_connection_set: Node Connection Binding”

Binds a connection to one action node on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
connection string Yes — Connection id.
pattern: "^[1-9][0-9]*$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"connection": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"connection",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"connectionId": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
}
},
"required": [
"nodeId",
"connectionId",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

node_continue_on_error_set: Node Error Continuation

Section titled “node_continue_on_error_set: Node Error Continuation”

Sets a development node’s continue-on-error state to the requested value; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
enabled boolean Yes — Desired continue-on-error state.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"enabled",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"changed": {
"type": "boolean"
}
},
"required": [
"nodeId",
"enabled",
"changed"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Deletes one node from the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Deletes one edge between development nodes; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
edge string Yes — Edge id.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"edge": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"edge",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Copies a node into the same development flow with an offset position and no incoming edges; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"newNodeId": {
"type": "string"
}
},
"required": [
"success",
"newNodeId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reads one development node with its component, inputs, outputs, and connection.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"displayName": {
"type": "string"
},
"nodeName": {
"type": "string"
},
"nodeSlug": {
"type": "string"
},
"key": {
"type": "string"
},
"connectionId": {
"type": [
"string",
"null"
]
},
"requireAuth": {
"type": "boolean"
},
"continueOnError": {
"type": "boolean"
},
"dynamicPropsId": {
"type": [
"string",
"null"
]
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"additionalProperties": true
},
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"displayName": {
"type": "string"
},
"dataType": {
"type": "string"
}
},
"required": [
"id",
"displayName",
"dataType"
],
"additionalProperties": true
}
},
"outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"displayName": {
"type": "string"
},
"dataType": {
"type": "string"
}
},
"required": [
"id",
"displayName",
"dataType"
],
"additionalProperties": true
}
},
"processOutput": {
"oneOf": [
{
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"declared": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"branches": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"onlyWhen": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"onlyWhenEnabled": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Sets or clears a development node’s execution guard from JavaScript or OR-of-AND expression groups; live remains unchanged until publication. Clearing removes only the guard, not the node.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
clear boolean No — Removes every condition; exactly one of clear=true, groups, or js is required.
const: true
groups array No — Condition groups whose inner expressions are AND-ed and whose groups are OR-ed; exactly one of groups, js, or clear=true is required.
minItems: 1
js string No — JavaScript condition; exactly one of js, groups, or clear=true is required.
minLength: 1; maxLength: 1048576
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Requires exactly one of clear=true, groups, or js.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"clear": {
"type": "boolean",
"const": true
},
"groups": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
}
}
},
"js": {
"type": "string",
"minLength": 1,
"maxLength": 1048576
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"clear": {}
},
"required": [
"clear"
]
},
{
"properties": {
"groups": {}
},
"required": [
"groups"
]
},
{
"properties": {
"js": {}
},
"required": [
"js"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"cleared": {
"type": "boolean"
},
"js": {
"type": [
"string",
"null"
]
},
"groups": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
}
}
},
"result": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
}
},
"required": [
"nodeId",
"cleared",
"js",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

node_optional_prop_list: Optional Property List

Section titled “node_optional_prop_list: Optional Property List”

Lists development node properties that can be enabled or disabled.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string"
},
"displayName": {
"type": "string"
},
"inputType": {
"type": "string"
},
"required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"value": {},
"valueJs": {},
"valueItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"valueJs": {
"type": [
"string",
"null"
]
}
},
"required": [
"index",
"valueJs"
],
"additionalProperties": true
}
},
"valueItemsTruncated": {
"type": "object",
"properties": {
"returned": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"returned",
"total"
],
"additionalProperties": false
},
"expressionValue": {},
"expressionValueJs": {},
"allowsExpressionMode": {
"type": "boolean"
},
"hasDynamicExpression": {
"type": "boolean"
},
"remoteOptions": {
"type": "boolean"
},
"reloadProps": {
"type": "boolean"
},
"optionsAvailability": {
"type": "string",
"enum": [
"available",
"blocked_upstream",
"dynamic_upstream"
]
},
"blockedBy": {
"type": [
"string",
"null"
]
},
"optionsIndependent": {
"type": "boolean"
},
"withLabel": {
"type": "boolean"
},
"source": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
{
"type": "object",
"properties": {
"props": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string"
},
"displayName": {
"type": "string"
},
"inputType": {
"type": "string"
},
"required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"value": {},
"valueJs": {},
"valueItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"valueJs": {
"type": [
"string",
"null"
]
}
},
"required": [
"index",
"valueJs"
],
"additionalProperties": true
}
},
"valueItemsTruncated": {
"type": "object",
"properties": {
"returned": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"returned",
"total"
],
"additionalProperties": false
},
"expressionValue": {},
"expressionValueJs": {},
"allowsExpressionMode": {
"type": "boolean"
},
"hasDynamicExpression": {
"type": "boolean"
},
"remoteOptions": {
"type": "boolean"
},
"reloadProps": {
"type": "boolean"
},
"optionsAvailability": {
"type": "string",
"enum": [
"available",
"blocked_upstream",
"dynamic_upstream"
]
},
"blockedBy": {
"type": [
"string",
"null"
]
},
"optionsIndependent": {
"type": "boolean"
},
"withLabel": {
"type": "boolean"
},
"source": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
}
},
"required": [
"props"
],
"additionalProperties": true
}
]
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

node_optional_prop_set: Optional Property State

Section titled “node_optional_prop_set: Optional Property State”

Enables or disables one optional property on a development node; live remains unchanged until publication. Disabling removes its stored value and can prune dependent properties.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
prop string Yes — Optional property key.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
enabled boolean Yes — Desired optional-prop state.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"prop": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"nodeId",
"prop",
"workflowId",
"enabled"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"enabled": {
"type": "boolean",
"const": true
},
"alreadyEnabled": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"enabled",
"alreadyEnabled",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"enabled": {
"type": "boolean",
"const": false
},
"alreadyDisabled": {
"type": "boolean"
},
"storedValueRemoved": {
"type": "boolean"
},
"message": {
"type": "string"
},
"nodeId": {
"type": "string"
},
"prop": {
"type": "string"
},
"verified": {
"type": "boolean",
"const": true
},
"readback": {
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string"
},
"displayName": {
"type": "string"
},
"inputType": {
"type": "string"
},
"required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"value": {},
"valueJs": {},
"expressionValue": {},
"expressionValueJs": {},
"allowsExpressionMode": {
"type": "boolean"
},
"hasDynamicExpression": {
"type": "boolean"
},
"remoteOptions": {
"type": "boolean"
},
"reloadProps": {
"type": "boolean"
},
"optionsAvailability": {
"type": "string",
"enum": [
"available",
"blocked_upstream",
"dynamic_upstream"
]
},
"blockedBy": {
"type": [
"string",
"null"
]
},
"source": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
},
"order": {
"type": "integer"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
}
},
"required": [
"enabled",
"nodeId",
"prop",
"verified",
"readback"
],
"additionalProperties": false
}
]
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

node_output_type_declare: Node Output Contract

Section titled “node_output_type_declare: Node Output Contract”

Declares an unverified dynamic output contract on a development node; live remains unchanged until publication, and a successful run provides stronger evidence.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
sample object | array Yes — Documented provider response: a JSON object or a non-empty array of objects.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"sample": {
"oneOf": [
{
"type": "object"
},
{
"type": "array",
"minItems": 1
}
]
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"sample",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"dataTypeName": {
"type": "string"
},
"declared": {
"type": "boolean",
"const": true
},
"status": {
"type": "string",
"enum": [
"declared"
]
}
},
"required": [
"nodeId",
"dataTypeName",
"declared",
"status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists visible and catalog properties for one development node with current values and decompiled expressions.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"props": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string"
},
"displayName": {
"type": "string"
},
"inputType": {
"type": "string"
},
"required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"value": {},
"valueJs": {},
"valueItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"valueJs": {
"type": [
"string",
"null"
]
}
},
"required": [
"index",
"valueJs"
],
"additionalProperties": true
}
},
"valueItemsTruncated": {
"type": "object",
"properties": {
"returned": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"returned",
"total"
],
"additionalProperties": false
},
"expressionValue": {},
"expressionValueJs": {},
"allowsExpressionMode": {
"type": "boolean"
},
"hasDynamicExpression": {
"type": "boolean"
},
"remoteOptions": {
"type": "boolean"
},
"reloadProps": {
"type": "boolean"
},
"optionsAvailability": {
"type": "string",
"enum": [
"available",
"blocked_upstream",
"dynamic_upstream"
]
},
"blockedBy": {
"type": [
"string",
"null"
]
},
"optionsIndependent": {
"type": "boolean"
},
"withLabel": {
"type": "boolean"
},
"source": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"note": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"subflowTarget": {
"type": "object",
"properties": {
"flowId": {
"type": [
"string",
"null"
]
},
"exists": {
"type": "boolean"
},
"nodeCount": {
"type": "integer"
}
},
"required": [
"flowId",
"exists",
"nodeCount"
],
"additionalProperties": false
}
},
"required": [
"props"
],
"additionalProperties": true
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists provider-defined dropdown options for one development node property. It can contact the provider through the selected connection.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint true
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
for array No — Earlier property overrides as prop=value entries; values accept JSON literals or bare text.
minItems: 1
page integer No — Zero-based option page when query is omitted.
minimum: 0
prevContext object No — Pagination context returned by the previous options page.
additionalProperties: true
prop string Yes — Property key returned by node_prop_list.
query string No — Option-label search term.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"for": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"pattern": "^[^=\\s][^=]*=.*$"
}
},
"page": {
"type": "integer",
"minimum": 0
},
"prevContext": {
"type": "object",
"additionalProperties": true
},
"prop": {
"type": "string"
},
"query": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"prop",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
},
{
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
},
"error": {
"type": "string"
},
"next": {
"type": "string"
},
"context": {},
"hasMore": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Contacts the provider, reloads dependent properties, and reconciles stored values, which can change node readiness.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint true
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"propsReloaded": {
"type": "boolean"
},
"propsReconciled": {
"type": "boolean"
},
"refreshedProps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string"
},
"displayName": {
"type": "string"
},
"inputType": {
"type": "string"
},
"required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"value": {},
"valueJs": {},
"valueItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"valueJs": {
"type": [
"string",
"null"
]
}
},
"required": [
"index",
"valueJs"
],
"additionalProperties": true
}
},
"valueItemsTruncated": {
"type": "object",
"properties": {
"returned": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"returned",
"total"
],
"additionalProperties": false
},
"expressionValue": {},
"expressionValueJs": {},
"allowsExpressionMode": {
"type": "boolean"
},
"hasDynamicExpression": {
"type": "boolean"
},
"remoteOptions": {
"type": "boolean"
},
"reloadProps": {
"type": "boolean"
},
"optionsAvailability": {
"type": "string",
"enum": [
"available",
"blocked_upstream",
"dynamic_upstream"
]
},
"blockedBy": {
"type": [
"string",
"null"
]
},
"optionsIndependent": {
"type": "boolean"
},
"withLabel": {
"type": "boolean"
},
"source": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"reconcileSkipped": {
"type": "string"
},
"note": {
"type": "string"
},
"readiness": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"requireAuth": {
"type": "boolean"
},
"connectionId": {
"type": [
"string",
"null"
]
},
"missingConnection": {
"type": "boolean"
},
"missingRequiredProps": {
"type": "array",
"items": {
"type": "string"
}
},
"disabledRequiredProps": {
"type": "array",
"items": {
"type": "string"
}
},
"pendingReloadProps": {
"type": "array",
"items": {
"type": "string"
}
},
"dynamicSelectorNotes": {
"type": "array",
"items": {
"type": "string"
}
},
"readinessState": {
"type": "string",
"enum": [
"ready",
"blocked",
"indeterminate"
]
},
"outputTypeStatus": {
"type": "string",
"enum": [
"concrete",
"unresolved",
"none"
]
},
"outputTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"outputPortTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"outputTypeSource": {
"type": "string",
"enum": [
"processOutput",
"component",
"port-wrapper",
"none"
]
},
"readyForExpressions": {
"type": "boolean"
},
"readyForRun": {
"type": "boolean"
},
"readyForDownstreamExpressions": {
"type": "boolean"
},
"blockedBy": {
"type": "array",
"items": {
"type": "string"
}
},
"next": {
"type": "string"
}
},
"required": [
"nodeId",
"requireAuth",
"connectionId",
"missingConnection",
"missingRequiredProps",
"disabledRequiredProps",
"pendingReloadProps",
"dynamicSelectorNotes",
"readinessState",
"outputTypeStatus",
"outputTypes",
"outputPortTypes",
"outputTypeSource",
"readyForExpressions",
"readyForRun",
"readyForDownstreamExpressions",
"blockedBy",
"next"
],
"additionalProperties": false
},
"readinessDelta": {
"type": "object",
"properties": {
"before": {
"type": "string",
"enum": [
"ready",
"blocked",
"indeterminate"
]
},
"after": {
"type": "string",
"enum": [
"ready",
"blocked",
"indeterminate"
]
},
"blockersResolved": {
"type": "array",
"items": {
"type": "string"
}
},
"blockersAdded": {
"type": "array",
"items": {
"type": "string"
}
},
"nextChanged": {
"oneOf": [
{
"type": "object",
"properties": {
"before": {
"type": "string"
},
"after": {
"type": "string"
}
},
"required": [
"before",
"after"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"before",
"after",
"blockersResolved",
"blockersAdded",
"nextChanged"
],
"additionalProperties": false
}
},
"required": [
"readiness",
"readinessDelta"
],
"additionalProperties": true
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Sets one node property from exactly one literal, preserved JSON value, JavaScript expression, or raw expression tree. Unlike flow_input_update, it changes action-node configuration; the change stays on the development version until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
js string No — JavaScript expression compiled against the node scope that expr_context describes; exactly one source is required.
minLength: 1; maxLength: 1048576
label array No — Live option labels aligned with supplied values for provider search.
minItems: 1
prop string Yes — Property key returned by node_prop_list.
rawExpressionJson object | array No — Exactly one source is required; raw Controller expression tree for constructs JavaScript cannot author.
value object | array | string | number | boolean | null No — Exactly one source is required; ordinary props parse booleans, null, numbers, and JSON, while text props decode JSON string literals and preserve other text.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
valueJson string No — Exactly one source is required; raw JSON spelling preserves coercible text on ordinary props, while text-expression props decode JSON string literals.
minLength: 1; validJson: true

Rules checked together:

  • Requires exactly one of value, valueJson, js, or rawExpressionJson.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"js": {
"type": "string",
"minLength": 1,
"maxLength": 1048576
},
"label": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
},
"prop": {
"type": "string"
},
"rawExpressionJson": {
"oneOf": [
{
"type": "object"
},
{
"type": "array"
}
]
},
"value": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"valueJson": {
"type": "string",
"minLength": 1
}
},
"required": [
"nodeId",
"prop",
"workflowId"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"value": {}
},
"required": [
"value"
]
},
{
"properties": {
"valueJson": {}
},
"required": [
"valueJson"
]
},
{
"properties": {
"js": {}
},
"required": [
"js"
]
},
{
"properties": {
"rawExpressionJson": {}
},
"required": [
"rawExpressionJson"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"prop": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"js",
"literal (compiled)",
"raw expression",
"static"
]
},
"source": {
"type": "string",
"enum": [
"explicit --js",
"synthesized from --value",
"explicit --raw-expression-json",
"explicit --value"
]
},
"persistedChannel": {
"type": "string",
"enum": [
"valueJs",
"expressionValueJs",
"value",
"expressionValue",
"value[0]"
]
},
"kind": {
"type": "string",
"enum": [
"decompiled JS",
"compiled literal"
]
},
"persistedValue": {},
"note": {
"type": "string"
},
"dynamicSelectorNote": {
"type": "string"
},
"readback": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string"
},
"displayName": {
"type": "string"
},
"inputType": {
"type": "string"
},
"required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"value": {},
"valueJs": {},
"valueItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"valueJs": {
"type": [
"string",
"null"
]
}
},
"required": [
"index",
"valueJs"
],
"additionalProperties": true
}
},
"valueItemsTruncated": {
"type": "object",
"properties": {
"returned": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"returned",
"total"
],
"additionalProperties": false
},
"expressionValue": {},
"expressionValueJs": {},
"allowsExpressionMode": {
"type": "boolean"
},
"hasDynamicExpression": {
"type": "boolean"
},
"remoteOptions": {
"type": "boolean"
},
"reloadProps": {
"type": "boolean"
},
"optionsAvailability": {
"type": "string",
"enum": [
"available",
"blocked_upstream",
"dynamic_upstream"
]
},
"blockedBy": {
"type": [
"string",
"null"
]
},
"optionsIndependent": {
"type": "boolean"
},
"withLabel": {
"type": "boolean"
},
"source": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {},
"id": {},
"label": {},
"name": {}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"result": {}
},
"required": [
"nodeId",
"prop",
"mode",
"source",
"persistedChannel",
"readback",
"result"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"prop": {
"type": "string"
},
"source": {
"const": "explicit --js"
},
"channel": {
"type": "string",
"enum": [
"valueJs",
"expressionValueJs",
"value",
"expressionValue",
"value[0]"
]
},
"kind": {
"type": "string",
"enum": [
"decompiled JS",
"compiled literal"
]
},
"inferredType": {
"type": [
"string",
"null"
]
},
"expectedType": {
"type": [
"string",
"null"
]
},
"persistedJs": {},
"persistedValue": {},
"note": {
"type": "string"
},
"dynamicSelectorNote": {
"type": "string"
},
"result": {}
},
"required": [
"nodeId",
"prop",
"source",
"channel",
"kind",
"inferredType",
"expectedType",
"persistedJs",
"persistedValue",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Renames a development node and its outgoing connection label; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
name string Yes — New node name.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"name",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reports deterministic configuration readiness and exact blockers for one development node.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"requireAuth": {
"type": "boolean"
},
"connectionId": {
"type": [
"string",
"null"
]
},
"missingConnection": {
"type": "boolean"
},
"missingRequiredProps": {
"type": "array",
"items": {
"type": "string"
}
},
"disabledRequiredProps": {
"type": "array",
"items": {
"type": "string"
}
},
"pendingReloadProps": {
"type": "array",
"items": {
"type": "string"
}
},
"dynamicSelectorNotes": {
"type": "array",
"items": {
"type": "string"
}
},
"readinessState": {
"type": "string",
"enum": [
"ready",
"blocked",
"indeterminate"
]
},
"outputTypeStatus": {
"type": "string",
"enum": [
"concrete",
"unresolved",
"none"
]
},
"outputTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"outputPortTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"outputTypeSource": {
"type": "string",
"enum": [
"processOutput",
"component",
"port-wrapper",
"none"
]
},
"readyForExpressions": {
"type": "boolean"
},
"readyForRun": {
"type": "boolean"
},
"readyForDownstreamExpressions": {
"type": "boolean"
},
"blockedBy": {
"type": "array",
"items": {
"type": "string"
}
},
"next": {
"type": "string"
},
"outputTypeDeclared": {
"type": "boolean",
"const": true
}
},
"required": [
"nodeId",
"requireAuth",
"connectionId",
"missingConnection",
"missingRequiredProps",
"disabledRequiredProps",
"pendingReloadProps",
"dynamicSelectorNotes",
"readinessState",
"outputTypeStatus",
"outputTypes",
"outputPortTypes",
"outputTypeSource",
"readyForExpressions",
"readyForRun",
"readyForDownstreamExpressions",
"blockedBy",
"next"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Points a development subflow node to one flow and regenerates its input properties from that flow; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Opaque node id in the selected workflow.
minLength: 1
flow string Yes — Flow id.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"flow": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"flow",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists the exact in-scope bindings for an expression at the selected development node property.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Node id.
methods boolean No — Whether to include the full method catalog.
prop string No — Target property, which supplies its expected type and mode.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"methods": {
"type": "boolean"
},
"prop": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"constants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"js": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"js",
"type"
],
"additionalProperties": true
}
},
"duplicateDisplayNames": {
"type": "array",
"items": {}
},
"flow": {
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"duplicateDisplayName": {
"type": "boolean"
},
"inputId": {
"type": [
"string",
"null"
]
},
"js": {
"type": "string"
},
"jsName": {
"type": "string"
},
"sourceNodeId": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"js",
"type",
"jsName",
"inputId",
"sourceNodeId",
"duplicateDisplayName"
],
"additionalProperties": true
}
},
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"duplicateDisplayName": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"display": {
"type": "string"
},
"js": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"display",
"js",
"type"
],
"additionalProperties": false
}
},
"inputId": {
"type": [
"string",
"null"
]
},
"js": {
"type": "string"
},
"jsName": {
"type": "string"
},
"resolvedType": {
"type": "string"
},
"sourceNodeId": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"js",
"type",
"jsName",
"inputId",
"sourceNodeId",
"duplicateDisplayName"
],
"additionalProperties": true
}
},
"item": {
"type": [
"null",
"object"
],
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"display": {
"type": "string"
},
"js": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"display",
"js",
"type"
],
"additionalProperties": false
}
},
"js": {
"type": "string"
},
"type": {
"type": "string"
}
},
"additionalProperties": true
},
"methods": {
"type": "object",
"properties": {
"any": {
"type": "array",
"items": {
"type": "string"
}
},
"boolean": {
"type": "array",
"items": {
"type": "string"
}
},
"custom": {
"type": "array",
"items": {
"type": "string"
}
},
"date": {
"type": "array",
"items": {
"type": "string"
}
},
"file": {
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"type": "array",
"items": {
"type": "string"
}
},
"number": {
"type": "array",
"items": {
"type": "string"
}
},
"text": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [],
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"nodeId": {
"type": "string"
},
"process": {
"type": [
"null",
"object"
],
"properties": {
"errorJs": {
"type": "string"
},
"js": {
"type": "string"
},
"type": {
"type": "string"
}
},
"additionalProperties": true
},
"schemas": {
"type": "object",
"additionalProperties": true
},
"targetProp": {
"type": [
"null",
"object"
],
"properties": {
"expectedType": {
"type": "string"
},
"expressionInputType": {
"type": "string"
},
"inputType": {
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"type": "string"
}
},
"additionalProperties": true
},
"targetPropError": {
"type": [
"null",
"string"
]
},
"unwiredUpstreamOutputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"note": {
"type": "string"
},
"outputDisplayName": {
"type": "string"
},
"sourceNodeId": {
"type": "string"
},
"sourceNodeName": {
"type": "string"
}
},
"required": [
"dataType",
"note",
"outputDisplayName",
"sourceNodeId",
"sourceNodeName"
],
"additionalProperties": true
}
},
"workflowData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"js": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"js",
"type"
],
"additionalProperties": true
}
}
},
"required": [
"constants",
"duplicateDisplayNames",
"flow",
"inputs",
"item",
"nodeId",
"process",
"schemas",
"targetProp",
"targetPropError",
"unwiredUpstreamOutputs",
"workflowData"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Translates one stored development node property expression into readable source.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Node id.
prop string Yes — Property key.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"prop": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"prop",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"prop": {
"type": "string"
},
"channel": {
"type": "string",
"enum": [
"valueJs",
"expressionValueJs"
]
},
"js": {
"type": [
"string",
"null"
]
},
"value": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {}
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
]
}
},
"required": [
"nodeId",
"prop",
"channel",
"js",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"prop": {
"type": "string"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"valueJs": {
"type": [
"string",
"null"
]
},
"value": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {}
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
]
}
},
"required": [
"index",
"valueJs",
"value"
],
"additionalProperties": false
}
},
"valueItemsTruncated": {
"type": "object",
"properties": {
"returned": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"returned",
"total"
],
"additionalProperties": false
}
},
"required": [
"nodeId",
"prop",
"elements"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"prop": {
"type": "string"
},
"elements": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {}
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
]
}
},
"note": {
"type": "string"
}
},
"required": [
"nodeId",
"prop",
"elements",
"note"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

expr_operation_list: Expression Operation Catalog

Section titled “expr_operation_list: Expression Operation Catalog”

Lists expression operations by base data type. The catalog comes from the selected workflow’s expression context and requires an explicit workflowId.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
type string No — Optional type id filter, for example list.custom.invoice; results group by base type, so list types map to list.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"any": {
"type": "array",
"items": {
"type": "string"
}
},
"boolean": {
"type": "array",
"items": {
"type": "string"
}
},
"custom": {
"type": "array",
"items": {
"type": "string"
}
},
"date": {
"type": "array",
"items": {
"type": "string"
}
},
"file": {
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"type": "array",
"items": {
"type": "string"
}
},
"number": {
"type": "array",
"items": {
"type": "string"
}
},
"text": {
"type": "array",
"items": {
"type": "string"
}
},
"requestedType": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Compiles an expression against the real development node scope without persisting it.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Node id.
js string Yes — JavaScript expression source compiled against the real node scope.
minLength: 1; maxLength: 1048576
mode string No — Compilation target when no property-specific target is available.
enum: ["text","expression","onlyWhen"]
prop string No — Target property used for type- and mode-specific validation.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"js": {
"type": "string",
"minLength": 1,
"maxLength": 1048576
},
"mode": {
"type": "string",
"enum": [
"text",
"expression",
"onlyWhen"
]
},
"prop": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"js",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"errorCategories": {
"type": "array",
"items": {}
},
"errorCategory": {
"type": [
"string",
"null"
]
},
"errorDetails": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {}
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
]
},
"errors": {
"type": "array",
"items": {}
},
"expression": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {}
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
]
},
"inferredType": {
"type": "string"
},
"roundTripJs": {
"type": "string"
},
"valid": {
"type": "boolean",
"const": true
},
"warnings": {
"type": "array",
"items": {}
}
},
"required": [
"valid"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Adds a Router route or an If/Else condition branch before Else on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Router or If/Else node id.
minLength: 1
allowDuplicate boolean No — Whether another sibling branch can use the same name.
conditionJson array No — OR-of-AND condition rows; mutually exclusive with js.
minItems: 1
js string No — JavaScript condition; mutually exclusive with conditionJson.
minLength: 1; maxLength: 1048576
name string No — Route or branch label.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Allows at most one of js or conditionJson.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"allowDuplicate": {
"type": "boolean"
},
"conditionJson": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
},
"js": {
"type": "string",
"minLength": 1,
"maxLength": 1048576
},
"name": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"allOf": [
{
"not": {
"anyOf": [
{
"properties": {
"js": {},
"conditionJson": {}
},
"required": [
"js",
"conditionJson"
]
}
]
}
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"conditionJs": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
]
},
"created": {
"type": "boolean"
},
"displayName": {
"type": "string"
},
"family": {
"type": "string",
"enum": [
"router",
"ifElse"
]
},
"id": {
"type": "string"
},
"nodeId": {
"type": "string"
},
"result": {
"type": [
"object",
"null"
],
"properties": {
"branchId": {
"type": "string"
},
"routeId": {
"type": "string"
},
"success": {
"type": "boolean"
},
"filledBlankRoute": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"created",
"family",
"id",
"nodeId",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Connects a branch output to a target node on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Router or If/Else node id.
minLength: 1
flow string No — Flow id containing both nodes; inferred when omitted.
branchId string Yes — Opaque route or condition-branch id returned by branch_list.
minLength: 1
to string Yes — Target node id.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"flow": {
"type": "string"
},
"branchId": {
"type": "string",
"minLength": 1
},
"to": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"branchId",
"to",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"edgeId": {
"type": "string"
},
"flowId": {
"type": "string"
},
"nodeId": {
"type": "string"
},
"nodeInputId": {
"type": "string"
},
"routeId": {
"type": "string"
},
"success": {
"type": "boolean"
},
"targetNodeId": {
"type": "string"
}
},
"required": [
"nodeId",
"routeId",
"targetNodeId",
"flowId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Deletes a route or condition branch and its branch edge from the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Router or If/Else node id.
minLength: 1
branchId string Yes — Opaque route or condition-branch id returned by branch_list.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"branchId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"branchId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"branchId": {
"type": "string"
},
"nodeId": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
},
"routeId": {
"type": "string"
}
},
"required": [
"nodeId",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists development routes or condition branches in evaluation order with their conditions and targets.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Router or If/Else node id.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditionJs": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
]
},
"displayName": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"route",
"condition",
"fallback"
]
},
"order": {
"type": "integer"
},
"targets": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"conditionJs",
"displayName",
"id",
"kind",
"order",
"targets"
],
"additionalProperties": false
}
},
"family": {
"type": "string",
"enum": [
"router",
"ifElse"
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditionJs": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
]
},
"displayName": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"route",
"condition",
"fallback"
]
},
"order": {
"type": "integer"
},
"targets": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"conditionJs",
"displayName",
"id",
"kind",
"order",
"targets"
],
"additionalProperties": false
}
},
"nodeId": {
"type": "string"
}
},
"required": [
"entries",
"family",
"items",
"nodeId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reorders If/Else condition branches on the development version; live remains unchanged until publication. The first matching branch wins, so order changes execution semantics.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Router or If/Else node id.
minLength: 1
order array Yes — Every condition branch id in the desired evaluation order.
minItems: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"order": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1
}
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"order",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"elseLast": {
"type": "string"
},
"nodeId": {
"type": "string"
},
"orderedBranchIds": {
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"type": "object",
"properties": {
"orderedBranchIds": {
"type": "array",
"items": {
"type": "string"
}
},
"success": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"elseLast",
"nodeId",
"orderedBranchIds",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Updates a route or condition branch name, condition, or both on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
nodeId string Yes — Router or If/Else node id.
minLength: 1
conditionJson array No — New OR-of-AND condition rows; provide at most one condition source and at least one update field.
minItems: 1
js string No — New JavaScript condition; provide at most one condition source and at least one update field.
minLength: 1; maxLength: 1048576
name string No — New label; provide this or one condition source.
branchId string Yes — Opaque route or condition-branch id returned by branch_list.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Allows at most one of js or conditionJson.
  • Requires a name or condition change.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"minLength": 1
},
"conditionJson": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
},
"js": {
"type": "string",
"minLength": 1,
"maxLength": 1048576
},
"name": {
"type": "string"
},
"branchId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"nodeId",
"branchId",
"workflowId"
],
"allOf": [
{
"not": {
"anyOf": [
{
"properties": {
"js": {},
"conditionJson": {}
},
"required": [
"js",
"conditionJson"
]
}
]
}
},
{
"anyOf": [
{
"properties": {
"name": {}
},
"required": [
"name"
]
},
{
"properties": {
"js": {}
},
"required": [
"js"
]
},
{
"properties": {
"conditionJson": {}
},
"required": [
"conditionJson"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"branchId": {
"type": "string"
},
"condition": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
]
},
"displayName": {
"type": [
"string",
"null"
]
},
"nodeId": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"branchId": {
"type": "string"
},
"routeId": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
},
"routeId": {
"type": "string"
}
},
"required": [
"condition",
"displayName",
"nodeId",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Answers any question about the company (decisions, owners, customers, projects, policies, documents) from its communication, meetings and other sources, resolving aliases, with cited facts and up to 8 entries. Start here before email, calendar or web search; brain_fetch reads more, brain_data_query answers numbers.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
question string Yes — The user’s company question in their own words.
minLength: 1; maxLength: 1000; pattern: "\\S"
after string No — Earliest date or timestamp to include; must not be later than before.
before string No — Latest date or timestamp to include.
sources array No — Sources to include; omit to search all indexed sources.
minItems: 1; maxItems: 5
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"pattern": "\\S"
},
"after": {
"oneOf": [
{
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T"
}
]
},
"before": {
"oneOf": [
{
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T"
}
]
},
"sources": {
"type": "array",
"minItems": 1,
"maxItems": 5,
"items": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"summaries",
"asana"
]
}
}
},
"required": [
"question"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"interpretation": {
"type": "object",
"properties": {
"intent": {
"type": "string",
"enum": [
"current_state",
"what_happened",
"who",
"how_many",
"why",
"find_document",
"general"
]
},
"queries": {
"type": "array",
"minItems": 1,
"maxItems": 9,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"window": {
"type": "object",
"properties": {
"after": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"before": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"after",
"before"
],
"additionalProperties": false
},
"planner": {
"type": "string",
"enum": [
"model",
"fallback"
]
}
},
"required": [
"intent",
"queries",
"window",
"planner"
],
"additionalProperties": false
},
"facts": {
"type": "array",
"maxItems": 12,
"items": {
"type": "object",
"properties": {
"entity": {
"type": "string"
},
"attribute": {
"type": "string",
"maxLength": 80
},
"slotKind": {
"type": "string",
"enum": [
"owner",
"status",
"date",
"number",
"decision",
"policy"
]
},
"value": {
"type": "string",
"maxLength": 300
},
"state": {
"type": "string",
"enum": [
"current",
"superseded",
"contested",
"proposed"
]
},
"certainty": {
"type": "string",
"enum": [
"stated",
"decided",
"proposed",
"reported",
"asked"
]
},
"statedBy": {
"type": [
"string",
"null"
]
},
"statedAt": {
"type": "string",
"format": "date-time"
},
"quote": {
"type": "string",
"maxLength": 240
},
"evidenceId": {
"type": "string",
"pattern": "^(chunk|slack):(.{1,500})$"
},
"url": {
"type": [
"string",
"null"
]
},
"replaces": {
"anyOf": [
{
"type": "object",
"properties": {
"value": {
"type": "string",
"maxLength": 300
},
"statedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"value",
"statedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"otherValue": {
"anyOf": [
{
"type": "object",
"properties": {
"value": {
"type": "string",
"maxLength": 300
},
"statedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"value",
"statedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"live": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"completed": {
"type": "boolean"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"assignee": {
"type": [
"string",
"null"
]
},
"dueOn": {
"type": [
"string",
"null"
]
},
"dueAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"modifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"checkedAt": {
"type": "string",
"format": "date-time"
},
"changedSinceIndex": {
"type": "boolean"
}
},
"required": [
"name",
"completed",
"completedAt",
"assignee",
"dueOn",
"dueAt",
"modifiedAt",
"checkedAt",
"changedSinceIndex"
],
"additionalProperties": false
}
},
"required": [
"entity",
"attribute",
"slotKind",
"value",
"state",
"certainty",
"statedBy",
"statedAt",
"quote",
"evidenceId",
"url",
"replaces",
"otherValue"
],
"additionalProperties": false
}
},
"entries": {
"type": "array",
"maxItems": 8,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^(chunk|slack|summary):(.{1,500})$"
},
"source": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"asana",
"summaries"
]
},
"official": {
"type": "boolean"
},
"where": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"people": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": [
"string",
"null"
]
},
"excerpt": {
"type": "string",
"maxLength": 1200
},
"relevance": {
"type": [
"string",
"null"
],
"enum": [
"strong",
"partial",
"weak",
null
]
},
"matched": {
"type": [
"string",
"null"
],
"maxLength": 120
},
"group": {
"type": [
"string",
"null"
]
},
"live": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"completed": {
"type": "boolean"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"assignee": {
"type": [
"string",
"null"
]
},
"dueOn": {
"type": [
"string",
"null"
]
},
"dueAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"modifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"checkedAt": {
"type": "string",
"format": "date-time"
},
"changedSinceIndex": {
"type": "boolean"
}
},
"required": [
"name",
"completed",
"completedAt",
"assignee",
"dueOn",
"dueAt",
"modifiedAt",
"checkedAt",
"changedSinceIndex"
],
"additionalProperties": false
}
},
"required": [
"id",
"source",
"official",
"where",
"title",
"date",
"endDate",
"people",
"url",
"excerpt",
"relevance",
"matched",
"group"
],
"additionalProperties": false
}
},
"coverage": {
"type": "object",
"properties": {
"searched": {
"type": "array",
"minItems": 0,
"maxItems": 5,
"items": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"summaries",
"asana"
]
}
},
"sources": {
"type": "object",
"properties": {
"slack": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"drive": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"meetings": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"summaries": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"asana": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
}
},
"required": [
"slack",
"drive",
"meetings",
"summaries",
"asana"
],
"additionalProperties": false
},
"note": {
"type": "string",
"const": "Only content you can access is included."
}
},
"required": [
"searched",
"sources",
"note"
],
"additionalProperties": false
},
"more": {
"type": "array",
"maxItems": 20,
"items": {
"type": "string",
"pattern": "^(chunk|slack|summary):(.{1,500})$"
}
},
"guidance": {
"type": "array",
"items": {
"type": "string"
}
},
"teamMethods": {
"type": "array",
"maxItems": 3,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"skill": {
"type": "string"
}
},
"required": [
"name",
"description",
"skill"
],
"additionalProperties": false
}
}
},
"required": [
"interpretation",
"facts",
"entries",
"coverage",
"more",
"guidance"
],
"additionalProperties": false
}

Run read-only SELECT/WITH SQL using fully qualified names discovered with brain_data_sources. Large results return in pages; prefer aggregation in SQL for summaries and use brain_data_result for more rows. Cite the source and show the SQL in the answer.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
sourceId integer Yes — Source id returned by brain_data_sources.
minimum: 1
sql string Yes — Read-only SQL, at most 20,000 characters; refusals are audited.
maxLength: 200000
limit integer No 200 Maximum rows per page; defaults to 200, bounded by the source setting and 48,000 JSON characters.
minimum: 1; maximum: 1000
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"sourceId": {
"type": "integer",
"minimum": 1
},
"sql": {
"type": "string",
"maxLength": 200000
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 1000,
"default": 200
}
},
"required": [
"sourceId",
"sql"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"additionalProperties": false
}
},
"rows": {
"type": "array",
"items": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
},
{
"type": "null"
}
]
}
}
},
"rowCount": {
"type": "integer",
"minimum": 0
},
"totalRows": {
"type": "integer",
"minimum": 0
},
"truncated": {
"type": "boolean"
},
"resultId": {
"type": "string",
"pattern": "^q_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"nextOffset": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"durationMs": {
"type": "number",
"minimum": 0
},
"sql": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"required": [
"columns",
"rows",
"rowCount",
"totalRows",
"truncated",
"resultId",
"nextOffset",
"expiresAt",
"durationMs",
"sql",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"refused": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string"
},
"detail": {
"type": "string"
}
},
"required": [
"refused",
"reason"
],
"additionalProperties": false
}
]
}

brain_data_result: Continue live company data result

Section titled “brain_data_result: Continue live company data result”

Continue a previous live warehouse result using its resultId and nextOffset as offset, without re-running SQL. Results expire at expiresAt and remain available only to the original user while their source and included scope remain accessible.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
resultId string Yes — Opaque result id returned by brain_data_query.
pattern: "^q_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
offset integer Yes — Row offset to fetch; use nextOffset from the previous page.
minimum: 0; maximum: 9007199254740991
limit integer No 200 Maximum rows per page; defaults to 200, bounded by the source setting and 48,000 JSON characters.
minimum: 1; maximum: 1000
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"resultId": {
"type": "string",
"pattern": "^q_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 1000,
"default": 200
}
},
"required": [
"resultId",
"offset"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"additionalProperties": false
}
},
"rows": {
"type": "array",
"items": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
},
{
"type": "null"
}
]
}
}
},
"rowCount": {
"type": "integer",
"minimum": 0
},
"totalRows": {
"type": "integer",
"minimum": 0
},
"truncated": {
"type": "boolean"
},
"resultId": {
"type": "string",
"pattern": "^q_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"nextOffset": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"durationMs": {
"type": "number",
"minimum": 0
},
"sql": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"required": [
"columns",
"rows",
"rowCount",
"totalRows",
"truncated",
"resultId",
"nextOffset",
"expiresAt",
"durationMs",
"sql",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"refused": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string"
},
"detail": {
"type": "string"
}
},
"required": [
"refused",
"reason"
],
"additionalProperties": false
}
]
}

brain_data_sources: Discover live company data

Section titled “brain_data_sources: Discover live company data”

Discover live warehouse tables in the included company scope; call brain_data_sources before writing SQL and use fully qualified database.schema.table names. Pass up to 20 table names to get their columns, and use brain_data_query to query live data.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
search string No — Filter by table or column name or comment.
maxLength: 200
tables array No — Fully qualified table names whose columns should be returned.
maxItems: 20
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"search": {
"type": "string",
"maxLength": 200
},
"tables": {
"type": "array",
"maxItems": 20,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1600
}
}
},
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"snowflake"
]
},
"dialect": {
"type": "string",
"enum": [
"snowflake"
]
},
"schemas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"database": {
"type": "string"
},
"schema": {
"type": "string"
},
"comment": {
"type": [
"string",
"null"
]
},
"tables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"table",
"view",
"materialized_view",
"external"
]
},
"comment": {
"type": [
"string",
"null"
]
},
"rowCount": {
"type": [
"number",
"null"
]
},
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"nullable": {
"type": "boolean"
},
"comment": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"type",
"nullable",
"comment"
],
"additionalProperties": false
}
}
},
"required": [
"name",
"kind",
"comment",
"rowCount"
],
"additionalProperties": false
}
}
},
"required": [
"database",
"schema",
"comment",
"tables"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"kind",
"dialect",
"schemas"
],
"additionalProperties": false
}
},
"truncated": {
"type": "boolean"
}
},
"required": [
"sources",
"truncated"
],
"additionalProperties": false
}

Read the full section, thread, meeting part, Asana task or summary behind a brain_ask or brain_search entry id. An Asana task carries a live block read from Asana just now; without one it was not checked and its state is as of the last sync.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
id string Yes — Evidence id returned by brain_ask, brain_search or brain_recent.
pattern: "^(chunk|slack|summary):(.{1,500})$"
offset integer No 0 Character offset for paging; defaults to zero.
minimum: 0; maximum: 9007199254740991
maxChars integer No 6000 Maximum characters for this page; defaults to 6000 and can be reduced to fit the response.
minimum: 1; maximum: 48000
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^(chunk|slack|summary):(.{1,500})$"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"default": 0
},
"maxChars": {
"type": "integer",
"minimum": 1,
"maximum": 48000,
"default": 6000
}
},
"required": [
"id"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"asana",
"summaries"
]
},
"official": {
"type": "boolean"
},
"title": {
"type": "string"
},
"label": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
},
"occurredAt": {
"type": "string",
"format": "date-time"
},
"people": {
"type": "array",
"items": {
"type": "string"
}
},
"matched": {
"type": "array",
"items": {
"type": "object",
"properties": {
"query": {
"type": "string"
},
"legs": {
"type": "array",
"items": {
"type": "string",
"enum": [
"english",
"simple",
"vector"
]
}
}
},
"required": [
"query",
"legs"
],
"additionalProperties": false
}
},
"text": {
"type": "string"
},
"includedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ts": {
"type": "string"
},
"userId": {
"type": [
"string",
"null"
]
}
},
"required": [
"ts",
"userId"
],
"additionalProperties": false
}
},
"live": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"completed": {
"type": "boolean"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"assignee": {
"type": [
"string",
"null"
]
},
"dueOn": {
"type": [
"string",
"null"
]
},
"dueAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"modifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"checkedAt": {
"type": "string",
"format": "date-time"
},
"changedSinceIndex": {
"type": "boolean"
}
},
"required": [
"name",
"completed",
"completedAt",
"assignee",
"dueOn",
"dueAt",
"modifiedAt",
"checkedAt",
"changedSinceIndex"
],
"additionalProperties": false
},
"offset": {
"type": "integer",
"minimum": 0
},
"nextOffset": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"meta": {
"type": "object",
"properties": {
"indexed": {
"type": "object",
"properties": {
"slack": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"drive": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"meetings": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"summaries": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"asana": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
}
},
"required": [
"slack",
"drive",
"meetings",
"summaries",
"asana"
],
"additionalProperties": false
}
},
"required": [
"indexed"
],
"additionalProperties": false
}
},
"required": [
"id",
"source",
"official",
"title",
"label",
"url",
"occurredAt",
"people",
"matched",
"text",
"offset",
"nextOffset",
"meta"
],
"additionalProperties": false
}

brain_recent: What’s happening at the company

Section titled “brain_recent: What’s happening at the company”

What’s going on at the company: the latest nightly summaries or, while summaries are off, the newest conversations, meetings, tasks and documents the caller can see (meta.note says which). Use for a catch-up or ‘what happened’ with no topic; brain_fetch reads an entry in full.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
sources array No — Sources to include; omit to search all indexed sources.
minItems: 1; maxItems: 5
days integer No 3 Number of recent days to include; defaults to 3, at most 14.
minimum: 1; maximum: 14
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"sources": {
"type": "array",
"minItems": 1,
"maxItems": 5,
"items": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"summaries",
"asana"
]
}
},
"days": {
"type": "integer",
"minimum": 1,
"maximum": 14,
"default": 3
}
},
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"asana",
"summaries"
]
},
"official": {
"type": "boolean"
},
"title": {
"type": "string"
},
"label": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
},
"occurredAt": {
"type": "string",
"format": "date-time"
},
"people": {
"type": "array",
"items": {
"type": "string"
}
},
"matched": {
"type": "array",
"items": {
"type": "object",
"properties": {
"query": {
"type": "string"
},
"legs": {
"type": "array",
"items": {
"type": "string",
"enum": [
"english",
"simple",
"vector"
]
}
}
},
"required": [
"query",
"legs"
],
"additionalProperties": false
}
},
"text": {
"type": "string",
"maxLength": 1500
},
"includedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ts": {
"type": "string"
},
"userId": {
"type": [
"string",
"null"
]
}
},
"required": [
"ts",
"userId"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"source",
"official",
"title",
"label",
"url",
"occurredAt",
"people",
"matched",
"text"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"indexed": {
"type": "object",
"properties": {
"slack": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"drive": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"meetings": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"summaries": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"asana": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
}
},
"required": [
"slack",
"drive",
"meetings",
"summaries",
"asana"
],
"additionalProperties": false
},
"omittedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"summaries": {
"type": "string",
"enum": [
"on",
"off"
]
},
"note": {
"type": [
"string",
"null"
]
}
},
"required": [
"indexed",
"omittedIds",
"summaries",
"note"
],
"additionalProperties": false
}
},
"required": [
"entries",
"meta"
],
"additionalProperties": false
}

Find specific company evidence with query, source, date, channel and people filters; returns cited snippets. Start broad questions with brain_ask, read more with brain_fetch, and use brain_data_sources/brain_data_query for numeric or warehouse questions.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
queries array Yes — First query: the user’s own wording; optionally add up to four rephrasings using company terms, names and codes.
minItems: 1; maxItems: 5
sources array No — Sources to include; omit to search all indexed sources.
minItems: 1; maxItems: 5
after string No — Earliest date or timestamp to include; must not be later than before.
before string No — Latest date or timestamp to include.
channelIds array No — Slack channel ids to include.
minItems: 1; maxItems: 100
people array No — Participant display names to match.
minItems: 1; maxItems: 100
limit integer No 8 Maximum snippet entries; defaults to 8.
minimum: 1; maximum: 25
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"queries": {
"type": "array",
"minItems": 1,
"maxItems": 5,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"pattern": "\\S"
}
},
"sources": {
"type": "array",
"minItems": 1,
"maxItems": 5,
"items": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"summaries",
"asana"
]
}
},
"after": {
"oneOf": [
{
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T"
}
]
},
"before": {
"oneOf": [
{
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T"
}
]
},
"channelIds": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"people": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "\\S"
}
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 25,
"default": 8
}
},
"required": [
"queries"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"entries": {
"type": "array",
"maxItems": 25,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"asana",
"summaries"
]
},
"official": {
"type": "boolean"
},
"title": {
"type": "string"
},
"label": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
},
"occurredAt": {
"type": "string",
"format": "date-time"
},
"people": {
"type": "array",
"items": {
"type": "string"
}
},
"matched": {
"type": "array",
"items": {
"type": "object",
"properties": {
"query": {
"type": "string"
},
"legs": {
"type": "array",
"items": {
"type": "string",
"enum": [
"english",
"simple",
"vector"
]
}
}
},
"required": [
"query",
"legs"
],
"additionalProperties": false
}
},
"snippet": {
"type": "string",
"maxLength": 600
},
"relevance": {
"type": [
"string",
"null"
],
"enum": [
"strong",
"partial",
"weak",
null
]
},
"alsoIn": {
"type": "array",
"maxItems": 5,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"label",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"source",
"official",
"title",
"label",
"url",
"occurredAt",
"people",
"matched",
"snippet",
"relevance",
"alsoIn"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"indexed": {
"type": "object",
"properties": {
"slack": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"drive": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"meetings": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"summaries": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
},
"asana": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"available",
"lastSyncAt",
"from",
"to"
],
"additionalProperties": false
}
},
"required": [
"slack",
"drive",
"meetings",
"summaries",
"asana"
],
"additionalProperties": false
},
"keywordOnly": {
"type": "boolean"
},
"reranked": {
"type": "boolean"
},
"bestRelevance": {
"type": [
"string",
"null"
],
"enum": [
"strong",
"partial",
"weak",
null
]
},
"omittedIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20
}
},
"required": [
"indexed",
"keywordOnly",
"reranked",
"bestRelevance",
"omittedIds"
],
"additionalProperties": false
}
},
"required": [
"entries",
"meta"
],
"additionalProperties": false
}

Lists the company sources connected to the brain: how fresh each is, the date range of content the caller can access, and what it includes. Use when a question depends on what data exists or how far back it goes.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
None — — — This tool takes an empty input object.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {},
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"type": "object",
"properties": {
"sources": {
"type": "array",
"minItems": 6,
"maxItems": 6,
"items": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"slack",
"drive",
"meetings",
"asana",
"summaries",
"snowflake"
]
},
"connected": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"connected",
"pending",
"needs_reconnect",
"not_connected"
]
},
"lastSyncAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"available": {
"type": "boolean"
},
"includes": {
"type": "string",
"minLength": 1,
"maxLength": 400
}
},
"required": [
"source",
"connected",
"status",
"lastSyncAt",
"from",
"to",
"available",
"includes"
],
"additionalProperties": false
}
},
"knowledge": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"additionalProperties": false
},
"note": {
"type": "string",
"const": "Only content you can access is included."
}
},
"required": [
"sources",
"knowledge",
"note"
],
"additionalProperties": false
}

Creates a custom data type and its backing data collection on the development version; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
name string Yes — Custom data type name beginning with custom.
pattern: "^custom\\.[A-Za-z0-9_.-]+$"
display string No — Human label, defaulting to the unprefixed type name.
field array No — Complete field definitions in id:type[:display] form with unique ids; provide exactly one of field or fromJson.
minItems: 1; uniqueFieldIds: true
fromJson object No — Complete JSON definition with unique field ids; provide exactly one of field or fromJson.
additionalProperties: false
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Requires exactly one of field or fromJson.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^custom\\.[A-Za-z0-9_.-]+$"
},
"display": {
"type": "string"
},
"field": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*:(?:list\\.)?(?:text|number|boolean|date|custom\\.[A-Za-z0-9_.-]+)(?::[^:\\s][^:]*)?$"
}
},
"fromJson": {
"type": "object",
"additionalProperties": false,
"required": [
"fields"
],
"properties": {
"display": {
"type": "string",
"minLength": 1
},
"fields": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"display": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"pattern": "^(?:list\\.)?(?:text|number|boolean|date|custom\\.[A-Za-z0-9_.-]+)$"
}
}
}
}
}
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"name",
"workflowId"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"field": {}
},
"required": [
"field"
]
},
{
"properties": {
"fromJson": {}
},
"required": [
"fromJson"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"display": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"display": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"display",
"type"
],
"additionalProperties": false
}
},
"nodeSlug": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"display",
"fields"
],
"additionalProperties": false
},
"result": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
}
},
"required": [
"name",
"schema",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Removes the development type and deactivates its collection without deleting stored rows. Recreating the same type and field IDs reactivates values; cross-type reference fields removed from other types are not restored automatically. Live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
name string Yes — Custom data type name beginning with custom.
pattern: "^custom\\.[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^custom\\.[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"name",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
}
},
"required": [
"name",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reads one development data type with its field ids, display names, and types.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
name string Yes — Custom data type name beginning with custom.
pattern: "^custom\\.[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^custom\\.[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"name",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"display": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"display": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"display",
"type"
],
"additionalProperties": false
}
},
"nodeSlug": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"name",
"display",
"fields"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists every data type defined on the development version.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
all boolean No — Whether to include integration-generated custom.__* types.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"all": {
"type": "boolean"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"display": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"display": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"display",
"type"
],
"additionalProperties": false
}
},
"nodeSlug": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"name",
"display",
"fields"
],
"additionalProperties": false
}
},
"schemas": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"display": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"display": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"display",
"type"
],
"additionalProperties": false
}
},
"nodeSlug": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"display",
"fields"
],
"additionalProperties": false
}
},
"hiddenSystemSchemas": {
"type": "integer"
}
},
"required": [
"items",
"schemas",
"hiddenSystemSchemas"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Resolves one development type id to its display name, fields, and list status.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
typeId string Yes — Type id, for example text, custom.invoice, list.custom.invoice, or node.<nodeId>.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"typeId": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"typeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"typeId": {
"type": "string"
},
"resolvedId": {
"type": "string"
},
"display": {
"type": "string"
},
"isUnknown": {
"type": "boolean"
},
"isList": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"display": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"display",
"type"
],
"additionalProperties": false
}
}
},
"required": [
"typeId",
"resolvedId",
"display",
"isUnknown",
"isList",
"fields"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Updates a custom data type on the development version. Supplying field or fromJson replaces the complete field list, removing omitted fields; a display-only update preserves fields. Live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
name string Yes — Custom data type name beginning with custom.
pattern: "^custom\\.[A-Za-z0-9_.-]+$"
display string No — New human label; provide this, field, or fromJson.
field array No — Complete replacement fields in id:type[:display] form with unique ids; mutually exclusive with fromJson, and provide display, field, or fromJson.
minItems: 1; uniqueFieldIds: true
fromJson object No — Complete JSON definition with unique field ids; mutually exclusive with field, and provide display, field, or fromJson.
additionalProperties: false
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Allows at most one of field or fromJson.
  • Requires a display or whole field-definition change.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^custom\\.[A-Za-z0-9_.-]+$"
},
"display": {
"type": "string"
},
"field": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*:(?:list\\.)?(?:text|number|boolean|date|custom\\.[A-Za-z0-9_.-]+)(?::[^:\\s][^:]*)?$"
}
},
"fromJson": {
"type": "object",
"additionalProperties": false,
"required": [
"fields"
],
"properties": {
"display": {
"type": "string",
"minLength": 1
},
"fields": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"display": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"pattern": "^(?:list\\.)?(?:text|number|boolean|date|custom\\.[A-Za-z0-9_.-]+)$"
}
}
}
}
}
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"name",
"workflowId"
],
"allOf": [
{
"not": {
"anyOf": [
{
"properties": {
"field": {},
"fromJson": {}
},
"required": [
"field",
"fromJson"
]
}
]
}
},
{
"anyOf": [
{
"properties": {
"display": {}
},
"required": [
"display"
]
},
{
"properties": {
"field": {}
},
"required": [
"field"
]
},
{
"properties": {
"fromJson": {}
},
"required": [
"fromJson"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"display": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"display": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"display",
"type"
],
"additionalProperties": false
}
},
"nodeSlug": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"display",
"fields"
],
"additionalProperties": false
},
"persistedSchema": {
"oneOf": [
{
"type": "object",
"properties": {
"display": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"display": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"display",
"type"
],
"additionalProperties": false
}
},
"nodeSlug": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"display",
"fields"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"droppedFields": {
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
}
},
"required": [
"name",
"schema",
"persistedSchema",
"droppedFields",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

data_collection_list: Data Collection List

Section titled “data_collection_list: Data Collection List”

Lists collections and row counts in one development or live record store.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
env string No "dev" Record store to read.
enum: ["dev","live"]
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"env": {
"type": "string",
"enum": [
"dev",
"live"
],
"default": "dev"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"collections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"display": {
"type": "string"
},
"recordCount": {
"type": "integer"
},
"schemaKey": {
"type": "string"
}
},
"required": [
"active",
"display",
"recordCount",
"schemaKey"
],
"additionalProperties": false
}
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"display": {
"type": "string"
},
"recordCount": {
"type": "integer"
},
"schemaKey": {
"type": "string"
}
},
"required": [
"active",
"display",
"recordCount",
"schemaKey"
],
"additionalProperties": false
}
}
},
"required": [
"collections",
"environment",
"items"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Copies selected live records into the development record store under the same record ids, so development runs can read and update them. Live data is never changed; overwrite=true replaces development records that already use those ids.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
overwrite boolean No false Replace development records that already use the same ids; false skips them.
recordIds array Yes — Live record ids to copy, at most 200; each keeps its id in the development store.
minItems: 1; maxItems: 200
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"overwrite": {
"type": "boolean",
"default": false
},
"recordIds": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "string",
"minLength": 1
}
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"recordIds",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"collectionId": {
"type": "integer"
},
"dataType": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"createdCount": {
"type": "integer"
},
"devCollectionId": {
"type": "integer"
},
"liveCollectionId": {
"type": "integer"
},
"recordIds": {
"type": "array",
"items": {
"type": "string"
}
},
"requested": {
"type": "integer"
},
"schemaMatchesLive": {
"type": "boolean"
},
"skippedCount": {
"type": "integer"
},
"skippedRecordIds": {
"type": "array",
"items": {
"type": "string"
}
},
"updatedCount": {
"type": "integer"
}
},
"required": [
"createdCount",
"devCollectionId",
"liveCollectionId",
"recordIds",
"requested",
"schemaMatchesLive",
"skippedCount",
"skippedRecordIds",
"updatedCount"
],
"additionalProperties": false
},
"workflowVersionId": {
"type": "integer"
}
},
"required": [
"collectionId",
"dataType",
"result",
"workflowVersionId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Upserts active development rows into the matching published Live collection by record key; publish first if its schema is absent or out of date. Matches are overwritten or revived, Live-only rows remain, and an empty source changes nothing. Published runs see the changed data immediately. There is no dry run; env=live is required as explicit acknowledgement.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
env string Yes — Record store, which must be live.
enum: ["dev","live"]

Rules checked together:

  • env must be live because this operation always mutates the live store.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"env": {
"type": "string",
"enum": [
"dev",
"live"
]
}
},
"required": [
"type",
"workflowId",
"env"
],
"allOf": [
{
"not": {
"properties": {
"env": {
"const": "dev"
}
},
"required": [
"env"
]
}
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"collectionId": {
"type": "integer"
},
"dataType": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"createdCount": {
"type": "integer"
},
"liveCollectionId": {
"type": "integer"
},
"totalRecords": {
"type": "integer"
},
"updatedCount": {
"type": "integer"
}
},
"required": [],
"additionalProperties": false
},
"workflowVersionId": {
"type": "integer"
}
},
"required": [
"collectionId",
"dataType",
"result",
"workflowVersionId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists field ids and display names for one collection. Record writes use field ids, while reads return display names.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"display": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"display": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"display",
"id",
"type"
],
"additionalProperties": false
}
}
},
"required": [
"dataType",
"display",
"fields"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Creates one record in the selected store after schema validation. env=live changes data read by the published workflow immediately.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
env string Yes — Explicit record store to change; no write tool defaults this value.
enum: ["dev","live"]
fields object Yes — Field values keyed by schema field id, not display name.
additionalProperties: true
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"env": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"fields": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"env",
"fields",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"record": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"dataType",
"environment",
"record"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Soft-deletes one record from the selected development or live store. There is no public undo; recreate deleted records from a known source. env=live changes data read by the published workflow immediately.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
recordId string Yes — Record id.
env string Yes — Explicit record store to change; no write tool defaults this value.
enum: ["dev","live"]
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"recordId": {
"type": "string"
},
"env": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"recordId",
"env",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"id": {
"type": "string"
}
},
"required": [
"dataType",
"deleted",
"environment",
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

data_record_delete_many: Bulk Record Deletion

Section titled “data_record_delete_many: Bulk Record Deletion”

Soft-deletes explicit record IDs or every record in the selected collection. There is no public undo; recreate deleted records from a known source. env=live changes data read by the published workflow immediately.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
all boolean No — All-record selector; exactly one of all=true or recordIds is required.
const: true
env string Yes — Explicit record store to change; env=live changes data read by the published workflow immediately.
enum: ["dev","live"]
recordIds array No — Record-id selector; exactly one of recordIds or all=true is required.
minItems: 1
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Requires exactly one of all=true or recordIds.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"all": {
"type": "boolean",
"const": true
},
"env": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"recordIds": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1
}
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"env",
"type",
"workflowId"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"all": {}
},
"required": [
"all"
]
},
{
"properties": {
"recordIds": {}
},
"required": [
"recordIds"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"all": {
"type": "boolean"
},
"collectionId": {
"type": "integer"
},
"dataType": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"recordKeys": {
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean"
},
"deletedCount": {
"type": "integer"
},
"ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"all",
"collectionId",
"dataType",
"environment",
"recordKeys",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reads one record ID from the selected collection, returning record: null when that ID is absent. Use data_record_query to paginate matching records.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
recordId string Yes — Record id, such as rec_123.
env string No "dev" Record store to read.
enum: ["dev","live"]
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"recordId": {
"type": "string"
},
"env": {
"type": "string",
"enum": [
"dev",
"live"
],
"default": "dev"
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"recordId",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"record": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"recordId": {
"type": "string"
}
},
"required": [
"dataType",
"environment",
"record",
"recordId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Validates CSV during the commit, appends valid rows, and skips invalid rows. A separate validation call is recommended but not required. Repeating commit appends valid rows again; inspect counts and query the same store before retrying. Headers use field display names. env=live changes data read by the published workflow immediately.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint false
openWorldHint false
Input Type Required Schema default Meaning and constraints
env string Yes — Explicit record store to change; env=live changes data read by the published workflow immediately.
enum: ["dev","live"]
content string Yes — UTF-8 CSV content; column names match schema display names.
maxLength: 2097152
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"env": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"content": {
"type": "string",
"maxLength": 2097152
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"env",
"content",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"collectionId": {
"type": "integer"
},
"dataType": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"mode": {
"type": "string",
"enum": [
"dryRun",
"commit"
]
},
"result": {
"type": "object",
"properties": {
"errorCount": {
"type": "integer"
},
"errors": {
"type": "array",
"items": {}
},
"importedCount": {
"type": "integer"
},
"mode": {
"type": "string",
"enum": [
"dryRun",
"commit"
]
},
"totalRows": {
"type": "integer"
},
"validCount": {
"type": "integer"
},
"warningCount": {
"type": "integer"
},
"warnings": {
"type": "array",
"items": {}
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"collectionId",
"dataType",
"environment",
"mode",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

data_record_import_validate: Record Import Validation

Section titled “data_record_import_validate: Record Import Validation”

Validates a CSV import without appending records. env=live validates against the published workflow store, and columns match field display names.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
env string Yes — Explicit record store to validate against; env=live checks the published workflow store without changing it.
enum: ["dev","live"]
content string Yes — UTF-8 CSV content; column names match schema display names.
maxLength: 2097152
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"env": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"content": {
"type": "string",
"maxLength": 2097152
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"env",
"content",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"collectionId": {
"type": "integer"
},
"dataType": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"mode": {
"type": "string",
"enum": [
"dryRun",
"commit"
]
},
"result": {
"type": "object",
"properties": {
"errorCount": {
"type": "integer"
},
"errors": {
"type": "array",
"items": {}
},
"importedCount": {
"type": "integer"
},
"mode": {
"type": "string",
"enum": [
"dryRun",
"commit"
]
},
"totalRows": {
"type": "integer"
},
"validCount": {
"type": "integer"
},
"warningCount": {
"type": "integer"
},
"warnings": {
"type": "array",
"items": {}
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"collectionId",
"dataType",
"environment",
"mode",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists a paginated collection with optional plain-text search, field-aware filter, and sort; data_record_get instead reads one known record id.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
env string No "dev" Record store to read.
enum: ["dev","live"]
limit integer No — Records per page, with a maximum of 100.
minimum: 1; maximum: 100
offset integer No — Record offset for pagination.
minimum: 0
query string No — Plain-text search, not a field-aware filter.
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
filter object No — Field filter { and, or } of { field, op, value }; all and conditions and at least one or condition must hold; contains on a list tests membership.
additionalProperties: false
sort object No — Sort by one field id or system field; missing values sort last.
additionalProperties: false
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"env": {
"type": "string",
"enum": [
"dev",
"live"
],
"default": "dev"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0
},
"query": {
"type": "string"
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"filter": {
"type": "object",
"properties": {
"and": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"eq",
"ne",
"gt",
"gte",
"lt",
"lte",
"contains",
"startsWith",
"isEmpty",
"isNotEmpty"
]
},
"value": {}
},
"required": [
"field",
"op"
],
"additionalProperties": false
}
},
"or": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"eq",
"ne",
"gt",
"gte",
"lt",
"lte",
"contains",
"startsWith",
"isEmpty",
"isNotEmpty"
]
},
"value": {}
},
"required": [
"field",
"op"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"sort": {
"type": "object",
"properties": {
"field": {
"type": "string",
"minLength": 1
},
"direction": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "asc"
}
},
"required": [
"field"
],
"additionalProperties": false
}
},
"required": [
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"totalCount": {
"type": "integer"
}
},
"required": [
"dataType",
"environment",
"items",
"records",
"totalCount"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Updates specified fields on one record while leaving omitted fields unchanged. env=live changes data read by the published workflow immediately.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
recordId string Yes — Record id.
env string Yes — Explicit record store to change; no write tool defaults this value.
enum: ["dev","live"]
fields object Yes — Field values keyed by schema field id, not display name.
additionalProperties: true
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"recordId": {
"type": "string"
},
"env": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"fields": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"recordId",
"env",
"fields",
"type",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"fieldIds": {
"type": "object",
"additionalProperties": true
},
"record": {
"type": "object",
"additionalProperties": true
},
"recordId": {
"type": "string"
}
},
"required": [
"dataType",
"environment",
"record",
"recordId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

data_record_update_many: Bulk Record Update

Section titled “data_record_update_many: Bulk Record Update”

Updates the same fields on up to 500 records selected by ids or a field-aware filter, in one all-or-nothing transaction; dryRun=true only previews the matches. env=live changes data read by the published workflow immediately.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
dryRun boolean No false Preview matched record ids and the count without writing anything.
env string Yes — Explicit record store to change; env=live changes data read by the published workflow immediately.
enum: ["dev","live"]
fields object Yes — Field values to set on every selected record, keyed by schema field id.
additionalProperties: true
filter object No — Field filter { and, or } of { field, op, value }; all and conditions and at least one or condition must hold; contains on a list tests membership.
additionalProperties: false
limit integer No — Most records one call can update, with a default and maximum of 500; a larger match fails without writing.
minimum: 1; maximum: 500
recordIds array No — Record-id selector of at most 500 ids; exactly one of recordIds or filter is required.
minItems: 1; maxItems: 500
type string Yes — Store-eligible custom data type, such as custom.invoice.
pattern: "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"

Rules checked together:

  • Requires exactly one of recordIds or filter.
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"dryRun": {
"type": "boolean",
"default": false
},
"env": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"fields": {
"type": "object",
"additionalProperties": true
},
"filter": {
"type": "object",
"properties": {
"and": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"eq",
"ne",
"gt",
"gte",
"lt",
"lte",
"contains",
"startsWith",
"isEmpty",
"isNotEmpty"
]
},
"value": {}
},
"required": [
"field",
"op"
],
"additionalProperties": false
}
},
"or": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"eq",
"ne",
"gt",
"gte",
"lt",
"lte",
"contains",
"startsWith",
"isEmpty",
"isNotEmpty"
]
},
"value": {}
},
"required": [
"field",
"op"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 500
},
"recordIds": {
"type": "array",
"minItems": 1,
"maxItems": 500,
"items": {
"type": "string",
"minLength": 1
}
},
"type": {
"type": "string",
"pattern": "^custom\\.(?!__)[A-Za-z0-9_.-]+$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"env",
"fields",
"type",
"workflowId"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"recordIds": {}
},
"required": [
"recordIds"
]
},
{
"properties": {
"filter": {}
},
"required": [
"filter"
]
}
]
}
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"collectionId": {
"type": "integer"
},
"dataType": {
"type": "string"
},
"dryRun": {
"type": "boolean"
},
"environment": {
"type": "string",
"enum": [
"dev",
"live"
]
},
"matched": {
"type": "integer"
},
"recordIds": {
"type": "array",
"items": {
"type": "string"
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"updated": {
"type": "integer"
}
},
"required": [
"collectionId",
"dataType",
"dryRun",
"environment",
"matched",
"recordIds",
"updated"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reports pre-publish trigger coverage, development dispatch, and duplicate-run risk.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"sourceId": {
"type": [
"integer",
"null"
]
}
},
"required": [
"canvasTriggerId",
"backendTriggerId",
"sourceId"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"presence": {
"type": "string",
"enum": [
"dev",
"live",
"both"
]
},
"devCanvasEnabled": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"deployment": {
"type": "object",
"properties": {
"devCanvasEnabled": {
"type": "boolean"
},
"liveCanvasEnabled": {
"type": [
"boolean",
"null"
]
},
"workflowActive": {
"type": "boolean"
},
"inLiveVersion": {
"type": "boolean"
},
"workflowLiveMatchesDev": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"devDispatchArmed": {
"type": "boolean"
},
"dualDispatchLive": {
"type": "boolean"
}
},
"required": [
"devCanvasEnabled",
"liveCanvasEnabled",
"workflowActive",
"inLiveVersion",
"workflowLiveMatchesDev",
"allowTestEvents",
"devDispatchArmed",
"dualDispatchLive"
],
"additionalProperties": false
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
}
},
"required": [
"stage"
],
"additionalProperties": false
},
"recordedEventCount": {
"type": "integer"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
},
"id": {
"type": "string"
},
"triggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"flowId": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": [
"integer",
"null"
]
}
},
"required": [
"identity",
"name",
"presence",
"devCanvasEnabled",
"allowTestEvents",
"deployment",
"readiness",
"recordedEventCount",
"issues",
"id",
"triggerId",
"backendTriggerId",
"enabled",
"flowId",
"nodeCount"
],
"additionalProperties": false
}
},
"summary": {
"type": "object",
"properties": {
"liveAfterPublish": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"sourceId": {
"type": [
"integer",
"null"
]
}
},
"required": [
"canvasTriggerId",
"backendTriggerId",
"sourceId"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"presence": {
"type": "string",
"enum": [
"dev",
"live",
"both"
]
},
"devCanvasEnabled": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"deployment": {
"type": "object",
"properties": {
"devCanvasEnabled": {
"type": "boolean"
},
"liveCanvasEnabled": {
"type": [
"boolean",
"null"
]
},
"workflowActive": {
"type": "boolean"
},
"inLiveVersion": {
"type": "boolean"
},
"workflowLiveMatchesDev": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"devDispatchArmed": {
"type": "boolean"
},
"dualDispatchLive": {
"type": "boolean"
}
},
"required": [
"devCanvasEnabled",
"liveCanvasEnabled",
"workflowActive",
"inLiveVersion",
"workflowLiveMatchesDev",
"allowTestEvents",
"devDispatchArmed",
"dualDispatchLive"
],
"additionalProperties": false
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
}
},
"required": [
"stage"
],
"additionalProperties": false
},
"recordedEventCount": {
"type": "integer"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
},
"id": {
"type": "string"
},
"triggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"flowId": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": [
"integer",
"null"
]
}
},
"required": [
"identity",
"name",
"presence",
"devCanvasEnabled",
"allowTestEvents",
"deployment",
"readiness",
"recordedEventCount",
"issues",
"id",
"triggerId",
"backendTriggerId",
"enabled",
"flowId",
"nodeCount"
],
"additionalProperties": false
}
},
"armed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"sourceId": {
"type": [
"integer",
"null"
]
}
},
"required": [
"canvasTriggerId",
"backendTriggerId",
"sourceId"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"presence": {
"type": "string",
"enum": [
"dev",
"live",
"both"
]
},
"devCanvasEnabled": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"deployment": {
"type": "object",
"properties": {
"devCanvasEnabled": {
"type": "boolean"
},
"liveCanvasEnabled": {
"type": [
"boolean",
"null"
]
},
"workflowActive": {
"type": "boolean"
},
"inLiveVersion": {
"type": "boolean"
},
"workflowLiveMatchesDev": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"devDispatchArmed": {
"type": "boolean"
},
"dualDispatchLive": {
"type": "boolean"
}
},
"required": [
"devCanvasEnabled",
"liveCanvasEnabled",
"workflowActive",
"inLiveVersion",
"workflowLiveMatchesDev",
"allowTestEvents",
"devDispatchArmed",
"dualDispatchLive"
],
"additionalProperties": false
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
}
},
"required": [
"stage"
],
"additionalProperties": false
},
"recordedEventCount": {
"type": "integer"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
},
"id": {
"type": "string"
},
"triggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"flowId": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": [
"integer",
"null"
]
}
},
"required": [
"identity",
"name",
"presence",
"devCanvasEnabled",
"allowTestEvents",
"deployment",
"readiness",
"recordedEventCount",
"issues",
"id",
"triggerId",
"backendTriggerId",
"enabled",
"flowId",
"nodeCount"
],
"additionalProperties": false
}
},
"doubleRunRisk": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"sourceId": {
"type": [
"integer",
"null"
]
}
},
"required": [
"canvasTriggerId",
"backendTriggerId",
"sourceId"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"presence": {
"type": "string",
"enum": [
"dev",
"live",
"both"
]
},
"devCanvasEnabled": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"deployment": {
"type": "object",
"properties": {
"devCanvasEnabled": {
"type": "boolean"
},
"liveCanvasEnabled": {
"type": [
"boolean",
"null"
]
},
"workflowActive": {
"type": "boolean"
},
"inLiveVersion": {
"type": "boolean"
},
"workflowLiveMatchesDev": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"devDispatchArmed": {
"type": "boolean"
},
"dualDispatchLive": {
"type": "boolean"
}
},
"required": [
"devCanvasEnabled",
"liveCanvasEnabled",
"workflowActive",
"inLiveVersion",
"workflowLiveMatchesDev",
"allowTestEvents",
"devDispatchArmed",
"dualDispatchLive"
],
"additionalProperties": false
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
}
},
"required": [
"stage"
],
"additionalProperties": false
},
"recordedEventCount": {
"type": "integer"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
},
"id": {
"type": "string"
},
"triggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"flowId": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": [
"integer",
"null"
]
}
},
"required": [
"identity",
"name",
"presence",
"devCanvasEnabled",
"allowTestEvents",
"deployment",
"readiness",
"recordedEventCount",
"issues",
"id",
"triggerId",
"backendTriggerId",
"enabled",
"flowId",
"nodeCount"
],
"additionalProperties": false
}
},
"newlyLiveOnPublish": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"sourceId": {
"type": [
"integer",
"null"
]
}
},
"required": [
"canvasTriggerId",
"backendTriggerId",
"sourceId"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"presence": {
"type": "string",
"enum": [
"dev",
"live",
"both"
]
},
"devCanvasEnabled": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"deployment": {
"type": "object",
"properties": {
"devCanvasEnabled": {
"type": "boolean"
},
"liveCanvasEnabled": {
"type": [
"boolean",
"null"
]
},
"workflowActive": {
"type": "boolean"
},
"inLiveVersion": {
"type": "boolean"
},
"workflowLiveMatchesDev": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"devDispatchArmed": {
"type": "boolean"
},
"dualDispatchLive": {
"type": "boolean"
}
},
"required": [
"devCanvasEnabled",
"liveCanvasEnabled",
"workflowActive",
"inLiveVersion",
"workflowLiveMatchesDev",
"allowTestEvents",
"devDispatchArmed",
"dualDispatchLive"
],
"additionalProperties": false
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
}
},
"required": [
"stage"
],
"additionalProperties": false
},
"recordedEventCount": {
"type": "integer"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
},
"id": {
"type": "string"
},
"triggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"flowId": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": [
"integer",
"null"
]
}
},
"required": [
"identity",
"name",
"presence",
"devCanvasEnabled",
"allowTestEvents",
"deployment",
"readiness",
"recordedEventCount",
"issues",
"id",
"triggerId",
"backendTriggerId",
"enabled",
"flowId",
"nodeCount"
],
"additionalProperties": false
}
}
},
"required": [
"liveAfterPublish",
"armed",
"doubleRunRisk",
"newlyLiveOnPublish"
],
"additionalProperties": false
}
},
"required": [
"items",
"summary"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

trigger_component_props: Trigger Property Schema

Section titled “trigger_component_props: Trigger Property Schema”

Resolves configurable trigger properties and the dynamic property id for dependent settings. It can contact the provider.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint true
Input Type Required Schema default Meaning and constraints
configured object No — Already selected trigger prop values keyed by prop name.
additionalProperties: true
connection string No — Connection id when the trigger needs authorization.
pattern: "^[1-9][0-9]*$"
dynamicPropsId string No — Prior dynamic property identifier for reloading dependent settings.
event string Yes — Exact event key returned by trigger_search.
node string Yes — Trigger integration slug.
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"configured": {
"type": "object",
"additionalProperties": true
},
"connection": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"dynamicPropsId": {
"type": "string"
},
"event": {
"type": "string"
},
"node": {
"type": "string"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"event",
"node",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"props": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"recoveredFromAdditionalPropsError": {
"type": "boolean"
},
"propsCatalogComplete": {
"type": "boolean"
},
"propsExample": {
"type": "object",
"additionalProperties": true
},
"propsForCreate": {
"type": "object",
"additionalProperties": true
},
"readyForCreate": {
"type": "boolean"
},
"unresolvedOptionProps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"props",
"recoveredFromAdditionalPropsError",
"propsCatalogComplete",
"propsExample",
"propsForCreate",
"readyForCreate",
"unresolvedOptionProps"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Creates a trigger source and canvas, deploying a real webhook or schedule that begins capturing provider traffic. Captured events do not run the workflow until publication unless development dispatch is armed with trigger_test_events_set or an event is replayed.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint false
openWorldHint true
Input Type Required Schema default Meaning and constraints
connection string No — Connection id when the trigger needs authorization.
pattern: "^[1-9][0-9]*$"
dynamicPropsId string No — Dynamic property identifier returned by trigger_component_props.
event string Yes — Exact event key returned by trigger_search.
flow string Yes — Flow id the trigger runs; a trigger targets exactly one flow.
node string Yes — Trigger integration slug.
props object No — Configured properties keyed by property name.
additionalProperties: true
sourceBasis string Yes — What the trigger source choice is based on: the user’s explicit request, the user’s answer to a question, or an existing workflow.
enum: ["explicit-in-request","user-answer","inferred-from-existing-workflow"]
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"connection": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"dynamicPropsId": {
"type": "string"
},
"event": {
"type": "string"
},
"flow": {
"type": "string"
},
"node": {
"type": "string"
},
"props": {
"type": "object",
"additionalProperties": true
},
"sourceBasis": {
"type": "string",
"enum": [
"explicit-in-request",
"user-answer",
"inferred-from-existing-workflow"
]
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"event",
"flow",
"node",
"sourceBasis",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"const": true
},
"triggerId": {
"type": "string"
},
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": "integer"
},
"triggerEventSourceId": {
"type": "integer"
},
"triggerNodeId": {
"type": "string"
},
"runSubflowNodeId": {
"type": "string"
},
"allowTestEvents": {
"type": "boolean"
},
"lifecycle": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"sourceId": {
"type": [
"integer",
"null"
]
}
},
"required": [
"canvasTriggerId",
"backendTriggerId",
"sourceId"
],
"additionalProperties": false
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
},
"nextAction": {
"type": "string"
}
},
"required": [
"stage",
"nextAction"
],
"additionalProperties": false
},
"capture": {
"type": "object",
"properties": {
"sourcePresent": {
"type": "boolean"
},
"sourceEnabled": {
"type": "boolean"
},
"deploymentRecorded": {
"type": "boolean"
},
"recordedEventCount": {
"type": "integer"
},
"latestEventAt": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"sourcePresent",
"sourceEnabled",
"deploymentRecorded",
"recordedEventCount",
"latestEventAt"
],
"additionalProperties": false
},
"deployment": {
"type": "object",
"properties": {
"devCanvasEnabled": {
"type": "boolean"
},
"liveCanvasEnabled": {
"type": [
"boolean",
"null"
]
},
"workflowActive": {
"type": "boolean"
},
"inLiveVersion": {
"type": "boolean"
},
"workflowLiveMatchesDev": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"devDispatchArmed": {
"type": "boolean"
},
"dualDispatchLive": {
"type": "boolean"
}
},
"required": [
"devCanvasEnabled",
"liveCanvasEnabled",
"workflowActive",
"inLiveVersion",
"workflowLiveMatchesDev",
"allowTestEvents",
"devDispatchArmed",
"dualDispatchLive"
],
"additionalProperties": false
},
"verification": {
"type": "object",
"properties": {
"lastDevRun": {
"oneOf": [
{
"type": "object",
"properties": {
"workflowExecutionId": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"pending",
"running",
"paused",
"completed",
"completed_with_error",
"failed",
"cancelled"
]
},
"at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"workflowExecutionId",
"status",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"lastLiveRun": {
"oneOf": [
{
"type": "object",
"properties": {
"workflowExecutionId": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"pending",
"running",
"paused",
"completed",
"completed_with_error",
"failed",
"cancelled"
]
},
"at": {
"type": "string",
"format": "date-time"
},
"matchesCurrentLive": {
"type": "boolean"
}
},
"required": [
"workflowExecutionId",
"status",
"at",
"matchesCurrentLive"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"lastDevRun",
"lastLiveRun"
],
"additionalProperties": false
},
"flowId": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": [
"integer",
"null"
]
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
}
},
"required": [
"identity",
"readiness",
"capture",
"deployment",
"verification",
"flowId",
"nodeCount",
"issues"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"sourceId": {
"type": [
"integer",
"null"
]
}
},
"required": [
"canvasTriggerId",
"backendTriggerId",
"sourceId"
],
"additionalProperties": false
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
},
"nextAction": {
"type": "string"
}
},
"required": [
"stage",
"nextAction"
],
"additionalProperties": false
},
"capture": {
"type": "object",
"properties": {
"sourcePresent": {
"type": "boolean"
},
"sourceEnabled": {
"type": "boolean"
},
"deploymentRecorded": {
"type": "boolean"
},
"recordedEventCount": {
"type": "integer"
},
"latestEventAt": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"sourcePresent",
"sourceEnabled",
"deploymentRecorded",
"recordedEventCount",
"latestEventAt"
],
"additionalProperties": false
},
"deployment": {
"type": "object",
"properties": {
"devCanvasEnabled": {
"type": "boolean"
},
"liveCanvasEnabled": {
"type": [
"boolean",
"null"
]
},
"workflowActive": {
"type": "boolean"
},
"inLiveVersion": {
"type": "boolean"
},
"workflowLiveMatchesDev": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"devDispatchArmed": {
"type": "boolean"
},
"dualDispatchLive": {
"type": "boolean"
}
},
"required": [
"devCanvasEnabled",
"liveCanvasEnabled",
"workflowActive",
"inLiveVersion",
"workflowLiveMatchesDev",
"allowTestEvents",
"devDispatchArmed",
"dualDispatchLive"
],
"additionalProperties": false
},
"verification": {
"type": "object",
"properties": {
"lastDevRun": {
"oneOf": [
{
"type": "object",
"properties": {
"workflowExecutionId": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"pending",
"running",
"paused",
"completed",
"completed_with_error",
"failed",
"cancelled"
]
},
"at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"workflowExecutionId",
"status",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"lastLiveRun": {
"oneOf": [
{
"type": "object",
"properties": {
"workflowExecutionId": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"pending",
"running",
"paused",
"completed",
"completed_with_error",
"failed",
"cancelled"
]
},
"at": {
"type": "string",
"format": "date-time"
},
"matchesCurrentLive": {
"type": "boolean"
}
},
"required": [
"workflowExecutionId",
"status",
"at",
"matchesCurrentLive"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"lastDevRun",
"lastLiveRun"
],
"additionalProperties": false
},
"flowId": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": [
"integer",
"null"
]
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
},
"provisional": {
"const": true
}
},
"required": [
"identity",
"readiness",
"capture",
"deployment",
"verification",
"flowId",
"nodeCount",
"issues",
"provisional"
],
"additionalProperties": false
}
]
},
{
"type": "null"
}
]
},
"lifecycleReadbackWarning": {
"type": "string"
},
"webhookUrl": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"schedule": {
"type": "string"
},
"outputType": {
"type": "string"
},
"note": {
"type": "string"
},
"nextSteps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"success",
"triggerId",
"canvasTriggerId",
"backendTriggerId",
"triggerEventSourceId",
"triggerNodeId",
"runSubflowNodeId",
"allowTestEvents",
"lifecycle",
"note"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Deletes a trigger and its canvas from the development version; the published trigger remains unchanged until workflow_publish. This immediately stops any armed development dispatch of real provider events for that trigger.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint true
idempotentHint true
openWorldHint true
Input Type Required Schema default Meaning and constraints
triggerId string Yes — Opaque canvas trigger id returned by trigger_list or trigger_create.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"triggerId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"triggerId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"triggerId": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"success": {
"const": true
}
},
"required": [
"success"
],
"additionalProperties": false
}
},
"required": [
"triggerId",
"result"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reads one captured trigger event with its full provider payload.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
eventId string Yes — Positive numeric captured event id returned by trigger_event_list.
pattern: "^[1-9][0-9]*$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"eventId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"eventId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"dataTypeName": {
"type": [
"string",
"null"
]
},
"payload": {}
},
"required": [
"id",
"createdAt",
"dataTypeName",
"payload"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Lists compact provider payload previews captured by one trigger; event_list instead reports account activity.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
limit integer No — Newest-first events per page; defaults to 5 and has a maximum of 50.
minimum: 1; maximum: 50
triggerId string Yes — Positive numeric backend trigger id returned by trigger_create.
pattern: "^[1-9][0-9]*$"
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"triggerId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"triggerId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: opaque; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"triggerId": {
"type": "integer"
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"dataTypeName": {
"type": [
"string",
"null"
]
},
"payloadPreview": {
"type": "object",
"properties": {
"topLevelKeys": {
"type": "array",
"items": {
"type": "string"
}
},
"topLevelKeyCount": {
"type": "integer"
},
"preview": {
"type": "string"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"topLevelKeys",
"topLevelKeyCount",
"preview",
"truncated"
],
"additionalProperties": false
}
},
"required": [
"id",
"createdAt",
"dataTypeName",
"payloadPreview"
],
"additionalProperties": false
}
}
},
"required": [
"triggerId",
"events"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

trigger_event_select: Trigger Sample Selection

Section titled “trigger_event_select: Trigger Sample Selection”

Selects a captured event as the development trigger sample, defining its output schema and potentially invalidating downstream expressions; live remains unchanged until publication.

OAuth: controller:full.

Annotation Value
readOnlyHint false
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
eventId string Yes — Positive numeric captured event id returned by trigger_event_list.
pattern: "^[1-9][0-9]*$"
triggerNodeId string Yes — Opaque canvas trigger node id returned by trigger_create.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"eventId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
},
"triggerNodeId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"eventId",
"triggerNodeId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"success": {
"const": true
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
},
"nextAction": {
"type": "string"
}
},
"required": [
"stage",
"nextAction"
],
"additionalProperties": false
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
},
"note": {
"type": "string"
}
},
"required": [
"success",
"readiness",
"issues"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}

Reads one trigger’s capture, deployment, verification, and issue state.

OAuth: controller:full.

Annotation Value
readOnlyHint true
destructiveHint false
idempotentHint true
openWorldHint false
Input Type Required Schema default Meaning and constraints
triggerId string Yes — Opaque canvas trigger id returned by trigger_list or trigger_create.
minLength: 1
workflowId string Yes — Workflow id.
pattern: "^[1-9][0-9]*$"
Complete input schema and cross-field constraints
{
"type": "object",
"properties": {
"triggerId": {
"type": "string",
"minLength": 1
},
"workflowId": {
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
},
"required": [
"triggerId",
"workflowId"
],
"additionalProperties": false
}

Output schema coverage: exact; applies to structuredContent.data inside the shared result.

Complete data output schema
{
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"canvasTriggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"sourceId": {
"type": [
"integer",
"null"
]
}
},
"required": [
"canvasTriggerId",
"backendTriggerId",
"sourceId"
],
"additionalProperties": false
},
"readiness": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"created",
"event_captured",
"sample_selected",
"mapped"
]
},
"nextAction": {
"type": "string"
}
},
"required": [
"stage",
"nextAction"
],
"additionalProperties": false
},
"capture": {
"type": "object",
"properties": {
"sourcePresent": {
"type": "boolean"
},
"sourceEnabled": {
"type": "boolean"
},
"deploymentRecorded": {
"type": "boolean"
},
"recordedEventCount": {
"type": "integer"
},
"latestEventAt": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"sourcePresent",
"sourceEnabled",
"deploymentRecorded",
"recordedEventCount",
"latestEventAt"
],
"additionalProperties": false
},
"deployment": {
"type": "object",
"properties": {
"devCanvasEnabled": {
"type": "boolean"
},
"liveCanvasEnabled": {
"type": [
"boolean",
"null"
]
},
"workflowActive": {
"type": "boolean"
},
"inLiveVersion": {
"type": "boolean"
},
"workflowLiveMatchesDev": {
"type": "boolean"
},
"allowTestEvents": {
"type": "boolean"
},
"devDispatchArmed": {
"type": "boolean"
},
"dualDispatchLive": {
"type": "boolean"
}
},
"required": [
"devCanvasEnabled",
"liveCanvasEnabled",
"workflowActive",
"inLiveVersion",
"workflowLiveMatchesDev",
"allowTestEvents",
"devDispatchArmed",
"dualDispatchLive"
],
"additionalProperties": false
},
"verification": {
"type": "object",
"properties": {
"lastDevRun": {
"oneOf": [
{
"type": "object",
"properties": {
"workflowExecutionId": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"pending",
"running",
"paused",
"completed",
"completed_with_error",
"failed",
"cancelled"
]
},
"at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"workflowExecutionId",
"status",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"lastLiveRun": {
"oneOf": [
{
"type": "object",
"properties": {
"workflowExecutionId": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"pending",
"running",
"paused",
"completed",
"completed_with_error",
"failed",
"cancelled"
]
},
"at": {
"type": "string",
"format": "date-time"
},
"matchesCurrentLive": {
"type": "boolean"
}
},
"required": [
"workflowExecutionId",
"status",
"at",
"matchesCurrentLive"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"lastDevRun",
"lastLiveRun"
],
"additionalProperties": false
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"schema_unavailable",
"optional_inputs_unmapped",
"zero_input_flow",
"canvas_disabled",
"shadowed_by_earlier_canvas",
"live_only",
"dual_dispatch_armed",
"other_live_source_consumers",
"source_unprovisioned",
"poll_paused",
"poll_failing",
"source_idle",
"flow_missing",
"malformed_canvas"
]
},
"severity": {
"type": "string",
"enum": [
"blocker",
"hazard",
"info"
]
},
"blocksNextAction": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"code",
"severity",
"blocksNextAction",
"detail"
],
"additionalProperties": false
}
},
"id": {
"type": "string"
},
"triggerId": {
"type": "string"
},
"backendTriggerId": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"devCanvasEnabled": {
"type": "boolean"
},
"flowId": {
"type": [
"string",
"null"
]
},
"nodeCount": {
"type": [
"integer",
"null"
]
},
"presence": {
"type": [
"string",
"null"
],
"enum": [
"dev",
"live",
"both",
null
]
}
},
"required": [
"identity",
"readiness",
"capture",
"deployment",
"verification",
"issues",
"id",
"triggerId",
"backendTriggerId",
"enabled",
"devCanvasEnabled",
"flowId",
"nodeCount",
"presence"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}