Workflow operators

The Workflow family contains 3 operators. Invoke other workflows and return values to a caller.

Operators in this family

• workflow.call
• workflow.invoke
• workflow.return

workflow.call

Calls another published workflow as a child run.

Version 1.0.0 · Semantics side_effect · Visibility advanced

Config

Field	Type	Required	Default	Description
revision	string	no	—	Specific revision or ‘latest’.
workflow_id	string	yes	—

Input ports

Port	Type	Required	Description
input	any	yes	Input

Output ports

Port	Type	Required	Description
output	any	no	Output

workflow.invoke

Invokes another deployment as a child run with depth-limited recursion. Calls the engine directly (no HTTP self-loopback) and enforces customer scoping at both the SQL and handler layer.

Version 1.0.0 · Semantics side_effect · Visibility advanced

Config

Field	Type	Required	Default	Description
deployment_id	string	yes	—	UUID of the deployment to invoke.
inputs	object	no	—	JSON payload passed as the child run’s initial inputs. Defaults to the upstream step’s output if omitted.
max_recursion_depth	integer	no	5	Maximum invocation chain depth before the engine refuses to spawn the child.
wait_for_completion	boolean	no	false	If true, block until the child run reaches a terminal status (or hits the wait timeout).

Input ports

Port	Type	Required	Description
input	any	no	Input

Output ports

Port	Type	Required	Description
output	object	no	Output

workflow.return

Terminates the current run early with an explicit value. The DAG scheduler detects the terminal marker on this step’s output and finalises the run as completed, skipping any remaining downstream steps.

Version 1.0.0 · Semantics side_effect · Idempotent · Visibility advanced

Config

Field	Type	Required	Default	Description
metadata	object	no	—	Optional metadata recorded alongside the return value (e.g. early-exit reason).
value	any	no	—	Final return value for the run. Defaults to the upstream step’s output if omitted.

Input ports

Port	Type	Required	Description
input	any	no	Input

Output ports

Port	Type	Required	Description
output	object	no	Output

Source schemas

Every operator above is rendered from its JSON schema in /opt/glyph/schemas/operators/:

• schemas/operators/workflow.call.json
• schemas/operators/workflow.invoke.json
• schemas/operators/workflow.return.json