workflows/<id>.json

Every field of a workflow file.

One workflow per file. Strict JSON. For a walkthrough, see Authoring a workflow.

Top level

FieldTypeRequiredMeaning
workflow_idstringyesThe id: lowercase letters, digits and underscores. Must equal the file name without .json.
namestringyesDisplay name. zeon run and zeon app accept it.
descriptionstringnoFree text.
versionstringnoDefault "1.0.0".
authorstringnoFree text.
created_at, updated_atstringyesISO 8601 timestamps.
simulation_validatedbooleannoDefault false.
inputsarraynoDeclared inputs (below). Default [].
canvas_uiobjectnoThe workflow's canvas (below).
objectsarrayyesLegacy object declarations. Always present; new workflows use inputs and keep [].
nodesarrayyesThe nodes (below).
edgesarrayyesThe edges (below).

Keep the file name and workflow_id identical: the app opens and saves workflows/<workflow_id>.json.

inputs[]

FieldTypeMeaning
namestringStarts with a letter; letters, digits, underscores.
typestringstring, int, float, object (a world object reference) or structured (schema-based data).
is_arraybooleanThe input takes a list. Default false.
descriptionstringShown in the app.
defaultValueanyUsed when a run gives no value. For object, an instance id in the world.
itemSchemaobjectFor a structured array: the fields of each item.

nodes[]

FieldTypeMeaning
node_idstringUnique in the workflow.
typestringstart, skill or end.
labelstringRequired. Shown on the graph and in the run log.
descriptionstringOptional.
skill_idstringSkill nodes: the folder name under skills/.
parametersobjectSkill nodes: parameter name to value. A value is a literal, {"$input": "<input name>"}, or {"object_ref": "<instance id>"}.

edges[]

FieldTypeMeaning
edge_idstringUnique in the workflow.
from_node, to_nodestringNode ids.
conditionobject{"type": "default"} (always; edges leaving the start node are always followed), {"type": "on_success"} or {"type": "on_failure"}.

canvas_ui

FieldTypeMeaning
kindstring"react".
source_refstringcanvas/<name>.tsx; the name lowercase letters, digits, underscores.
enabledbooleanfalse shows the standard form instead. Default true.
versioninteger1 or more. Default 1.
updated_atstringISO 8601, optional.

See Canvases.


Did this page help you?