JSON Schema

https://compozy.dev/schemas/workflows.json
{
  "type": "object",
  "required": ["name", "version", "tasks"],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the workflow"
    },
    "version": {
      "type": "string",
      "description": "Version of the workflow"
    },
    "description": {
      "type": "string",
      "description": "Description of what the workflow does"
    },
    "input": {
      "type": "object",
      "patternProperties": {
        "^.*$": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "Data type of the input field"
            },
            "required": {
              "type": "boolean",
              "description": "Whether the field is required"
            },
            "default": {
              "description": "Default value if not provided"
            },
            "description": {
              "type": "string",
              "description": "Description of the input field"
            }
          },
          "required": ["type"]
        }
      }
    },
    "tasks": {
      "type": "array",
      "items": {
        "$ref": "https://compozy.dev/schemas/tasks.json#/properties/tasks/items"
      }
    },
    "env": {
      "type": "object",
      "patternProperties": {
        "^.*$": {
          "type": "string",
          "description": "Environment variable value or reference"
        }
      }
    }
  }
}

Workflow Configuration

name
string

Name of the workflow

version
string

Version of the workflow

description
string

Description of what the workflow does

input
object

Input contract for the workflow

tasks
array
required

Array of task definitions that make up the workflow. For complete task configuration options and properties, see the Tasks API Reference.

env
object

Environment variable definitions

Expression Context

tasks
object

Access to task data

input
object

Access to workflow input data

env
object

Access to environment variables

error
object

Access to error information