workflows/<id>.json
Every field of a workflow file.
One workflow per file. Strict JSON. For a walkthrough, see Authoring a workflow.
Top level
| Field | Type | Required | Meaning |
|---|---|---|---|
workflow_id | string | yes | The id: lowercase letters, digits and underscores. Must equal the file name without .json. |
name | string | yes | Display name. zeon run and zeon app accept it. |
description | string | no | Free text. |
version | string | no | Default "1.0.0". |
author | string | no | Free text. |
created_at, updated_at | string | yes | ISO 8601 timestamps. |
simulation_validated | boolean | no | Default false. |
inputs | array | no | Declared inputs (below). Default []. |
canvas_ui | object | no | The workflow's canvas (below). |
objects | array | yes | Legacy object declarations. Always present; new workflows use inputs and keep []. |
nodes | array | yes | The nodes (below). |
edges | array | yes | The edges (below). |
Keep the file name and workflow_id identical: the app opens and saves workflows/<workflow_id>.json.
inputs[]
inputs[]| Field | Type | Meaning |
|---|---|---|
name | string | Starts with a letter; letters, digits, underscores. |
type | string | string, int, float, object (a world object reference) or structured (schema-based data). |
is_array | boolean | The input takes a list. Default false. |
description | string | Shown in the app. |
defaultValue | any | Used when a run gives no value. For object, an instance id in the world. |
itemSchema | object | For a structured array: the fields of each item. |
nodes[]
nodes[]| Field | Type | Meaning |
|---|---|---|
node_id | string | Unique in the workflow. |
type | string | start, skill or end. |
label | string | Required. Shown on the graph and in the run log. |
description | string | Optional. |
skill_id | string | Skill nodes: the folder name under skills/. |
parameters | object | Skill nodes: parameter name to value. A value is a literal, {"$input": "<input name>"}, or {"object_ref": "<instance id>"}. |
edges[]
edges[]| Field | Type | Meaning |
|---|---|---|
edge_id | string | Unique in the workflow. |
from_node, to_node | string | Node ids. |
condition | object | {"type": "default"} (always; edges leaving the start node are always followed), {"type": "on_success"} or {"type": "on_failure"}. |
canvas_ui
canvas_ui| Field | Type | Meaning |
|---|---|---|
kind | string | "react". |
source_ref | string | canvas/<name>.tsx; the name lowercase letters, digits, underscores. |
enabled | boolean | false shows the standard form instead. Default true. |
version | integer | 1 or more. Default 1. |
updated_at | string | ISO 8601, optional. |
See Canvases.
Updated about 19 hours ago
Did this page help you?