Workflow Studio

Nodes Reference

Every workflow node type with all configuration properties, inputs, outputs, and error handling options.

Node Structure

Every node in a workflow shares a common base structure. Type-specific config lives in the config object.

Field	Type	Required	Default	Description
id	string	required	—	Node identifier. Unique within the workflow. Used in edges and to reference node output.
type	enum	required	—	Node type: action · condition · loop · delay · transform · approval · http_request · set_variable · sub_workflow · log · error_handler · parallel · merge
name	string	optional	—	Human-readable label shown on the canvas.
config	object	required	—	Type-specific configuration object. See per-type docs below.
position	{ x, y }	optional	—	Canvas position for the visual editor. Ignored by the execution engine.
disabled	boolean	optional	false	If true, node is skipped during execution (outputs empty object). Useful for debugging.
retryPolicy	object	optional	—	Node-level retry config. Overrides workflow-level. See retry policy schema.
timeout	integer	optional	30000	Node execution timeout in milliseconds. Max 300000 (5 min). Throws on timeout.
onError	enum	optional	throw	throw (fail run) · continue (log and continue) · retry (use retryPolicy)
meta	object	optional	—	Arbitrary key-value metadata stored with the node. Not used at runtime.

Retry policy schema

Field	Type	Required	Default	Description
maxAttempts	integer	optional	3	Maximum number of attempts including the first.
strategy	enum	optional	exponential	fixed · exponential · linear
delayMs	integer	optional	1000	Base delay in milliseconds between retries.
maxDelayMs	integer	optional	60000	Maximum delay cap for exponential strategy.
retryOn	string[]	optional	—	Error codes that trigger a retry. Empty = retry on any error.

action — Integration Action

Executes a pre-built integration action (email, Slack, Jira, HTTP, DB write, etc.).

Field	Type	Required	Default	Description
action	string	required	—	Dot-notation action ID: "email.send" · "slack.postMessage" · "jira.createIssue" · "db.createRecord" etc.
connectorId	string	optional	—	For actions that need a connector (e.g. jira, slack). References a configured connector ID.
input	object	required	—	Action-specific input object. All values support {{template}} expressions.
outputMapping	object	optional	—	Rename action output keys: { myAlias: "originalKey" }. Makes output cleaner for downstream nodes.

Built-in actions (no connector required)

Action ID	Description	Key inputs
email.send	Send a transactional email	to, subject, body, templateId, attachments
notification.send	Send in-app FlowOS notification	userId, title, body, link
db.createRecord	Create a record in a DB table	tableSlug, fields
db.updateRecord	Update a record by ID	tableSlug, recordId, fields
db.deleteRecord	Delete a record by ID	tableSlug, recordId
db.queryRecords	Query records and return results	tableSlug, filters, sort, limit
itsm.createIncident	Create an ITSM incident	title, severity, description
itsm.resolveIncident	Resolve an incident	incidentId, resolution, rootCause
itsm.addComment	Add comment to ITSM record	entityType, entityId, body, type
catalog.submitRequest	Submit a service catalog request	catalogItemId, requestedBy, fields
secret.get	Read a vault secret value	name (returns value — never logged)
workflow.trigger	Trigger another workflow	workflowId, input

condition — Branch

Evaluates a boolean expression and routes to one of two branches (true edge or false edge).

Field	Type	Required	Default	Description
expression	string	required	—	A boolean expression using template syntax. e.g. "{{trigger.record.severity}} === 'P1'"
mode	enum	optional	simple	simple (single expression) · multi (array of named branches — acts as switch/case).
branches	object[]	optional	—	For mode=multi: [{ id, label, expression }]. First matching branch wins.
defaultBranch	string	optional	—	Branch ID to take when no multi-branch condition matches.

json

// Simple condition
{
  "id": "check-severity",
  "type": "condition",
  "config": {
    "expression": "{{trigger.record.severity}} === 'P1' || {{trigger.record.severity}} === 'P2'"
  }
}
// Edges: from check-severity (true) → pager-alert
//         from check-severity (false) → slack-notify

// Multi-branch (switch)
{
  "id": "route-by-category",
  "type": "condition",
  "config": {
    "mode": "multi",
    "branches": [
      { "id": "hardware",  "label": "Hardware",  "expression": "{{trigger.record.category}} === 'hardware'" },
      { "id": "software",  "label": "Software",  "expression": "{{trigger.record.category}} === 'software'" },
      { "id": "network",   "label": "Network",   "expression": "{{trigger.record.category}} === 'network'" }
    ],
    "defaultBranch": "hardware"
  }
}

loop — Iterate Over Array

Field	Type	Required	Default	Description
items	string (expr)	required	—	Expression resolving to the array to iterate over. e.g. "{{trigger.record.assignees}}"
mode	enum	optional	sequential	sequential (one at a time) · parallel (all at once, up to concurrency limit).
concurrency	integer	optional	10	Max parallel iterations for parallel mode.
itemVariable	string	optional	item	Variable name for the current item in iteration. Access as {{vars.item.*}}.
indexVariable	string	optional	index	Variable name for the current index (0-based).
breakOn	string	optional	—	Expression evaluated after each iteration. If true, loop stops early.

delay — Pause Execution

Field	Type	Required	Default	Description
mode	enum	required	—	duration (fixed wait) · until_time (wait until a timestamp) · until_condition (poll until true).
duration	string	optional	—	For mode=duration. ISO 8601 duration: "PT5M" (5 min), "PT1H30M" (90 min), "P1D" (1 day).
until	string	optional	—	For mode=until_time. ISO 8601 timestamp or expression resolving to one.
condition	string	optional	—	For mode=until_condition. Re-evaluated every pollIntervalMs until true.
pollIntervalMs	integer	optional	30000	How often to re-evaluate the condition. Min 5000ms.
maxWaitMs	integer	optional	86400000	Absolute maximum wait time in ms (default 24h). Throws if exceeded.

transform — Shape Data

Field	Type	Required	Default	Description
expression	string	required	—	A JSONata expression to transform the input data. The entire run context is available as $.
input	object	optional	—	Named variables to pass to the JSONata expression. Defaults to the full run context.
outputAs	string	optional	—	Variable name to store the result. Defaults to "output" — access as {{nodes.nodeId.output}}.

json

{
  "id": "reshape-incident",
  "type": "transform",
  "config": {
    "expression": "{ 'title': record.title, 'priority': record.severity & '-' & record.urgency, 'owners': record.cmdbItems.ownerEmail[] }",
    "input": { "record": "{{trigger.record}}" }
  }
}

approval — Human Approval Gate

Pauses the run and waits for a human to approve or reject before continuing.

Field	Type	Required	Default	Description
approvers	object	required	—	{ type: "user"\|"team"\|"expression", value: string }. Who can approve.
title	string	required	—	Title of the approval request shown to approvers.
description	string	optional	—	Details shown to approvers. Template expressions supported.
dueIn	string	optional	—	ISO 8601 duration. If not approved within this time, onTimeout fires.
onTimeout	enum	optional	reject	reject · approve · skip · fail. What happens if the approval times out.
notifyChannels	string[]	optional	—	Notification channel IDs to use for approval request messages.
fields	object[]	optional	—	Additional form fields approvers must fill out. Schema same as catalog form fields.

http_request — Outbound HTTP

Field	Type	Required	Default	Description
method	enum	required	—	GET · POST · PUT · PATCH · DELETE
url	string	required	—	Full URL. Template expressions supported.
headers	object	optional	—	Key-value header map. Values support template expressions.
queryParams	object	optional	—	URL query parameters. Merged with any params in the URL.
body	any	optional	—	Request body. Serialized as JSON unless content-type header overrides.
auth	object	optional	—	{ type: "bearer"\|"basic"\|"api_key", ... }. Auth applied to the request.
followRedirects	boolean	optional	true	Whether to follow HTTP 3xx redirects.
validateStatus	string	optional	2xx	Status range considered success: "2xx" · "any" · specific code like "200".
responseType	enum	optional	json	json · text · binary. How to parse the response body.
connectorId	string	optional	—	Optionally route through a configured connector for rate-limit and circuit-breaker tracking.

set_variable — Store Values

Field	Type	Required	Default	Description
variables	object	required	—	Key-value pairs to set. Values support template expressions. Available in later nodes as {{vars.KEY}}.
scope	enum	optional	run	run (this execution only) · workspace (persisted across runs — use with care).

subWorkflow — Call Another Workflow

Field	Type	Required	Default	Description
workflowId	string	required	—	ID of the workflow to call. Must be active (isActive: true).
inputMapping	object	optional	—	Map parent context paths to child payload keys: { childKey: "parent.ctx.path" }.
mode	enum	optional	sync	sync (wait for completion, max 30s) · async (fire and forget).

Sub-workflow must not contain a trigger node

The workflow referenced by workflowId must not have a trigger node — the executor calls it directly. Remove the trigger node before activating a sub-workflow. Sub-workflows can be nested up to 5 levels deep.

Outputs of each completed sub-workflow node are returned as nodeId_output keys, e.g. { "n2_output": { ... }, "n3_output": { ... } }. Access them in the parent workflow as ctx.nodeOutputs.subWorkflowNodeId.n2_output.

parallel — Fork Execution

Runs multiple branches simultaneously. Execution resumes at a merge node once all branches complete.

Field	Type	Required	Default	Description
branches	string[]	required	—	Array of node IDs that are the start of each parallel branch.
waitFor	enum	optional	all	all (wait for every branch) · any (continue as soon as one branch finishes).

log — Debug Output

Field	Type	Required	Default	Description
level	enum	optional	info	debug · info · warn · error. Visible in the run trace.
message	string	required	—	Log message. Template expressions supported.
data	any	optional	—	Additional structured data to attach to the log entry.

error_handler — Catch Errors

Catches errors thrown by upstream nodes and routes to a recovery branch. Must be connected via an onError edge.

Field	Type	Required	Default	Description
catchErrors	string[]	optional	—	Error codes to catch. Empty = catch all errors.
errorVariable	string	optional	error	Variable name for the error object: { code, message, nodeId, attemptCount }.

whatsapp — Send WhatsApp Message

Dispatches a WhatsApp message through the tenant's configured provider (Twilio or Meta Cloud API, set under Settings → Feedback Channels → WhatsApp — see the WhatsApp channel docs). Used by the built-in WhatsApp workflow templates (see the Automations reference).

Field	Type	Required	Default	Description
to	string	optional	—	Recipient phone number, an expression, or the literal "owner" (also accepts "@owner", "company_owner", "company owner", "admin") to resolve the tenant's configured owner alert number. Either this or toPhoneNumber/phone is required.
toPhoneNumber	string	optional	—	Alias for to — checked if to is not set.
phone	string	optional	—	Second fallback alias for to.
message	string	required	—	Message body. Template expressions supported. Either this or body/text is required.
mediaUrl	string	optional	—	Media URL to attach — appended on its own line to the message text if not already present (no native media API call).
waConfig	object	optional	—	Override the resolved provider credentials for this node instead of reading the tenant's Settings → Feedback Channels → WhatsApp config.
target	string	optional	—	Set to "owner" together with an empty to field as an alternative way to route to the owner alert number.
sendRealInTest	boolean	optional	false	Also accepted as sendLive / live. Sends a real message even during a Canvas test run instead of simulating it.
continueOnError	boolean	optional	false	If true, a delivery failure returns { sent: false, ... } instead of throwing and failing the run.

Phone number formatting

The resolved to value is auto-formatted before dispatch: a bare 10-digit Indian mobile number (starts with 6–9) is prefixed +91; any other 11–15 digit number with no leading + gets one prepended. Numbers already in E.164 form (+...) pass through unchanged.

Dry-run / simulated sends

During a Canvas test run the node does not call Twilio/Meta by default — it returns a simulated result ({ sent: true, simulated: true, deliveryStatus: "sent_via_twilio", note: "..." }) so test runs never burn live WhatsApp credits. The same simulation also fires outside test runs whenever to contains example.com, <, or mock. Set sendRealInTest (or sendLive / live) to true on the node config to force a real send during a test run.

If no WhatsApp provider is configured for the tenant, the node always resolves to { sent: false, deliveryStatus: "not_configured" } instead of throwing — regardless of continueOnError. Any other delivery failure (Twilio/Meta API error) throws and fails the run unless continueOnError is true. Check deliveryStatus in downstream nodes if you branch on delivery outcome.