Workflows

Node reference

Every workflow node type with its settings, validation rules, output variables and an example configuration — generated from the engine.

This reference is generated from the engine's node catalog (lib/workflow-schema.ts), its validation rules and its canvas summaries, so it always lists exactly the nodes the designer offers. "Validation" shows the messages you see when a required setting is missing. Every node's results are also available as {{<prefix>_<name>}}, where the prefix is the node's label in snake_case (or its configured output prefix), so two nodes of the same type don't overwrite each other.

Every node also has two engine-level options:

• onError: stop (default) fails the run; continue logs the error, sets last_error, last_error_node and has_error, and carries on. See Error handling.
• executionMode: sync (default) or async for nodes that can be fired and forgotten, such as Call Sub Workflow.

Triggers

Every workflow has one trigger. It decides when a run starts and which variables the run begins with. Workflows can also be started from the API, MCP or CLI (workflows start) whatever their trigger.

Task Created

task_created · When a new task is created.

Task Received

task_received · When a task lands in the queue.

Task Submitted

task_submitted · When a task is accepted.

Task Updated

task_updated · When a task is modified.

Task Completed

task_completed · When a task is completed.

Task Rejected

task_rejected · When a task is rejected from the queue.

Workflow Error

workflow_error · When any workflow fails with an error.

{
  "error_scope": "specific",
  "workflow_ids": [
    "<workflow-id>"
  ]
}

Workflow SLA

workflow_sla · When a workflow SLA is nearing or breached.

Policy Review

retention_policy_review · When a retention policy review becomes due.

Policy Executed

retention_policy_executed · When a retention policy action such as purge is executed.

Data Table Event

data_table_event · When a data table row is created, updated, or deleted.

{
  "table_id": "<table-id>",
  "event_types": [
    "created",
    "updated"
  ]
}

Middleware

middleware_received · Receive a webhook and return a workflow response synchronously.

Schedule

schedule · Run on a schedule.

{
  "schedule_mode": "daily",
  "time_of_day": "06:30",
  "timezone": "Europe/London"
}

Webhook

webhook_received · Triggered by an incoming webhook.

Logic and flow

Branching, loops, waits, jumps and parallel paths.

Branch by Condition

condition · If/else if/else branching.

{
  "branches": [
    {
      "label": "Large",
      "logic": "and",
      "rules": [
        {
          "field": "{{amount}}",
          "operator": "greater_than",
          "value": "10000"
        }
      ]
    }
  ],
  "has_else": true
}

Branch by Value

switch_case · Multi-way branch on a value.

{
  "field": "{{region}}",
  "cases": [
    {
      "value": "EU"
    },
    {
      "value": "US"
    }
  ],
  "has_default": true
}

Loop For Each

loop · Iterate over a collection.

{
  "items": "{{vendors}}",
  "item_var": "vendor"
}

Loop N Times

loop_n_times · Repeat N times.

{
  "count": 3
}

Pause for Duration

delay · Wait a fixed amount of time.

{
  "duration": 2,
  "unit": "hours"
}

Pause Until Date

pause_until · Wait until a specific date/time.

{
  "date": "{{=ADD_DAYS(NOW(), 1)}}"
}

End Workflow

end_workflow · Stop execution immediately.

Go To Activity

goto_activity · Jump to another activity on the canvas.

{
  "target_node_id": "<node-id>",
  "target_node_label": "Manager approval"
}

Parallel / Sequential

parallel · Run branches in parallel or sequentially.

{
  "mode": "parallel",
  "branches": [
    {
      "label": "Notify finance"
    },
    {
      "label": "Update ERP"
    }
  ]
}

Actions

Call systems, update tasks and data, notify people, run rules, agents and other workflows, and wait for people.

Update Task

update_task · Modify task fields.

{
  "field": "priority",
  "value": "high"
}

Data

update_data_table · Query, insert, update, or delete data store rows.

{
  "table_id": "<vendors-table-id>",
  "table_name": "Vendors",
  "operation": "get",
  "match_column": "vendor_id",
  "match_value": "{{vendor_id}}"
}

Retention Policies

retention_policies · Create, assign, and inspect retention policies and their assets.

Call API / Reference

call_reference · Execute an API reference.

{
  "reference_id": "<reference-id>",
  "reference_name": "Get vendor",
  "reference_method": "GET",
  "input_mappings": {
    "vendor_id": "{{vendor_id}}"
  }
}

Custom Activity

custom_activity · Run uploaded custom workflow code with typed inputs and outputs.

Create Subtask

create_subtask · Add a subtask.

{
  "title": "Collect W-9 from {{vendor.name}}",
  "assignee": "{{requester_id}}"
}

Auto Action

auto_action · Set status, outcome, acceptance.

{
  "status": "completed",
  "outcome": "Auto-approved"
}

HTTP Request

http_request · Make HTTP call.

{
  "method": "POST",
  "url": "https://hooks.example.com/notify",
  "body": "{\"invoice\":\"{{invoice_number}}\"}"
}

Log

log · Write audit log.

{
  "message": "Vendor {{vendor.id}} risk {{risk}}"
}

Send Email

send_email · Send an email via Resend.

{
  "to": "{{requester_email}}",
  "email_template_id": "<template-id>"
}

Call Sub Workflow

call_sub_workflow · Execute another workflow as a sub-process.

{
  "sub_workflow_id": "<workflow-id>",
  "sub_workflow_name": "Vendor onboarding",
  "input_mappings": {
    "vendor_id": "{{vendor_id}}"
  }
}

Decision Table

decision_table · Evaluate a business rule / decision table and return outputs.

{
  "decision_table_id": "<table-id>",
  "decision_table_name": "Invoice approval policy",
  "input_mappings": {
    "amount": "{{amount}}",
    "risk": "{{risk}}"
  }
}

User Task

user_task · Assign a task to a person and wait for action.

{
  "task_title": "Approve invoice {{invoice_number}}",
  "outcomes": [
    "Approved",
    "Rejected"
  ],
  "assignment_type": "team",
  "team_id": "<team-id>",
  "fields": [
    {
      "key": "cost_centre",
      "label": "Cost centre",
      "type": "choice",
      "options": [
        "OPS",
        "FIN"
      ]
    }
  ]
}

Placeholder

placeholder · Empty action — swap out later.

{
  "note": "Post to ERP once the API is ready"
}

Server Event

server_event · Emit or listen for a server event.

{
  "event_name": "invoice.approved"
}

Run Agent

run_agent · Execute an AI agent with tools and instructions.

{
  "agent_id": "<agent-id>",
  "agent_name": "Invoice triage",
  "user_message": "Classify invoice {{invoice_number}}",
  "output_variable": "triage"
}

Add User to Role

add_user_to_role · Assign a governance role to a user.

Remove from Role

remove_user_from_role · Remove a governance role from a user.

Data, files and documents

Transform values, JSON, dates, text, files and Office documents inside the run.

Set Title

set_title · Set the title for this workflow instance.

{
  "title": "Invoice {{invoice_number}} — {{vendor.name}}"
}

Set SLA

set_sla · Set the SLA deadline and warning threshold for this workflow run.

{
  "sla_label": "Invoice approval",
  "mode": "relative",
  "amount": 3,
  "unit": "days",
  "warning_amount": 1,
  "warning_unit": "days"
}

Set Variable

set_variable · Store a value.

{
  "name": "needs_cfo",
  "expression": "{{=IF(amount > 50000, true, false)}}"
}

Calculate Value

math · Math expression.

{
  "expression": "{{subtotal}} * 1.2",
  "output_var": "total"
}

Modify String

modify_string · Transform text.

{
  "input": "{{vendor.name}}",
  "operation": "slug",
  "output_var": "vendor_slug"
}

Create Text

text_template · Build text from template.

{
  "template": "Invoice {{invoice_number}} for {{=FORMAT_NUMBER(amount, 2)}} {{currency}}",
  "output_var": "summary"
}

Format Date

format_date · Format date to string.

{
  "date": "{{due_date}}",
  "format": "custom",
  "custom_format": "DD/MM/YYYY"
}

Date Math

date_math · Add time or find interval.

{
  "date": "{{received_at}}",
  "operation": "add",
  "amount": 30,
  "unit": "days",
  "output_var": "pay_by"
}

Regex

regex · Apply a regular expression.

{
  "input": "{{reference}}",
  "pattern": "INV-(\\d+)",
  "operation": "match",
  "output_var": "invoice_match"
}

Build JSON Object

json_build_object · Create or update a JSON object from key/value pairs.

{
  "fields": [
    {
      "key": "vendor",
      "value": "{{vendor.id}}"
    },
    {
      "key": "amount",
      "value": "{{amount}}"
    }
  ],
  "output_var": "payment"
}

Build JSON Array

json_build_array · Create a new JSON array or push items into an existing one.

{
  "items": [
    "{{a}}",
    "{{b}}"
  ],
  "output_var": "pair"
}

Add to JSON Array

json_add_to_array · Add an object to an existing JSON array variable.

{
  "array_var": "lines",
  "fields": [
    {
      "key": "sku",
      "value": "{{item.sku}}"
    }
  ]
}

Get JSON Value

json_get_value · Extract a value from a JSON object or array by path.

{
  "source": "{{response}}",
  "path": "data.vendor.risk",
  "output_var": "risk"
}

File to Base64

file_to_base64 · Read file from URL/storage → base64.

{
  "file_url": "{{task.files.0.url}}",
  "output_var": "pdf_base64"
}

Base64 to File

base64_to_file · Save base64 data as file in storage.

{
  "base64_data": "{{pdf_base64}}",
  "file_name": "invoice.pdf"
}

Download File

download_file · Download from URL to storage.

{
  "url": "{{response.document_url}}",
  "file_name": "statement.pdf"
}

Read File Content

read_file · Read file content as text.

{
  "file_url": "{{file_url}}"
}

CSV

read_csv · Read or write CSV files.

{
  "mode": "read",
  "file_url": "{{file_url}}",
  "has_headers": true,
  "output_var": "rows"
}

Excel

read_excel · Read or write Excel files.

{
  "mode": "write",
  "data_var": "rows",
  "file_name": "payments.xlsx"
}

Word Document

doc_word · Find/replace, tables, lists, images in Word docs.

{
  "template_url": "{{template_url}}",
  "mode": "find_replace",
  "replacements": [
    {
      "find": "{{VENDOR}}",
      "replace": "{{vendor.name}}"
    }
  ],
  "output_var": "contract"
}

Excel Spreadsheet

doc_excel · Update cells, find/replace, insert data in Excel.

{
  "template_url": "{{template_url}}",
  "mode": "find_replace",
  "replacements": [
    {
      "find": "{{TOTAL}}",
      "replace": "{{total}}"
    }
  ]
}

PowerPoint Slides

doc_powerpoint · Find/replace, tables, lists, images in PowerPoint.

{
  "template_url": "{{template_url}}",
  "mode": "find_replace",
  "replacements": [
    {
      "find": "{{QUARTER}}",
      "replace": "Q3"
    }
  ]
}

Check Permission

check_permission · Check if a user has a specific permission.

{
  "user_id": "{{task.assignee_id}}",
  "permission": "tasks.complete"
}

Collections

Count, pick, filter, sort, deduplicate and join lists.

Count Items

collection_count · Count items in a list.

{
  "collection": "{{lines}}",
  "output_var": "line_count"
}

Get Item

collection_get · Get item by index or key.

{
  "collection": "{{vendors}}",
  "by": "key",
  "key_field": "id",
  "key": "{{vendor_id}}",
  "output_var": "vendor"
}

Filter Collection

collection_filter · Filter items by condition.

{
  "collection": "{{lines}}",
  "field": "amount",
  "operator": "greater_than",
  "value": "0",
  "output_var": "billable"
}

Sort Collection

collection_sort · Sort items in a list.

{
  "collection": "{{lines}}",
  "field": "amount",
  "direction": "desc"
}

Remove Duplicates

collection_unique · Deduplicate a list.

{
  "collection": "{{emails}}"
}

Join to Text

collection_join · Join list items into a string.

{
  "collection": "{{lines}}",
  "field": "sku",
  "separator": ", "
}

Canvas tools

Organise the canvas or bind live data.

Section

section_group · Group activities into a collapsible section.

Live Reference

live_reference · Fetch fresh data on demand when variables are referenced.

{
  "reference_id": "<reference-id>",
  "reference_name": "Get exchange rate",
  "binding_name": "fx"
}