Skip to content

Output operators

Public

The Output family contains 5 operators. Terminal nodes: return, persist, notify, export, preview.

Exports output as a downloadable file.

Version 1.0.0 · Semantics side_effect

FieldTypeRequiredDefaultDescription
filenamestringno
format”json” | “csv” | “pdf” | “text”yes"json"
PortTypeRequiredDescription
inputanyyesInput
PortTypeRequiredDescription
artifactobjectnoArtifact

Sends a notification via email, Slack, webhook, etc.

Version 1.0.0 · Semantics side_effect

FieldTypeRequiredDefaultDescription
channel”email” | “slack” | “webhook”yes"webhook"
subjectstringno
targetstringyesRecipient address or webhook URL.
PortTypeRequiredDescription
inputanyyesInput

No output ports.

Writes output data to a persistent store.

Version 1.0.0 · Semantics side_effect

FieldTypeRequiredDefaultDescription
destination”s3” | “database” | “webhook”yes"s3"
pathstringno
PortTypeRequiredDescription
inputanyyesInput
PortTypeRequiredDescription
outputanynoOutput

Displays output in the run console for debugging.

Version 1.0.0 · Semantics side_effect

FieldTypeRequiredDefaultDescription
format”auto” | “json” | “text” | “markdown” | “table”no"auto"
PortTypeRequiredDescription
inputanyyesInput

No output ports.

Returns the final workflow output.

Version 1.0.0 · Semantics side_effect

FieldTypeRequiredDefaultDescription
format”json” | “text”no"json"
PortTypeRequiredDescription
inputanyyesInput

No output ports.

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

  • schemas/operators/output.export.json
  • schemas/operators/output.notify.json
  • schemas/operators/output.persist.json
  • schemas/operators/output.preview.json
  • schemas/operators/output.return.json