WorkflowCreateDto

Endpoints · All schemas

Field	Required	Description
description	No	Workflow description
enabled	No	Workflow enabled
extra	No	Additional fields of an imported definition, kept and exported unchanged
logging	No	Workflow logs run results
name	No	Workflow name
steps	No	array
trigger	Yes	Workflow trigger type. An unavailable trigger is kept, but the workflow cannot be enabled

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: WorkflowStepDto

{
  "properties": {
    "description": {
      "description": "Workflow description",
      "maxLength": 2000,
      "nullable": true,
      "type": "string"
    },
    "enabled": {
      "description": "Workflow enabled",
      "type": "boolean"
    },
    "extra": {
      "additionalProperties": {},
      "description": "Additional fields of an imported definition, kept and exported unchanged",
      "type": "object"
    },
    "logging": {
      "description": "Workflow logs run results",
      "type": "boolean"
    },
    "name": {
      "description": "Workflow name",
      "maxLength": 300,
      "nullable": true,
      "type": "string"
    },
    "steps": {
      "items": {
        "$ref": "#/components/schemas/WorkflowStepDto"
      },
      "maxItems": 100,
      "type": "array"
    },
    "trigger": {
      "description": "Workflow trigger type. An unavailable trigger is kept, but the workflow cannot be enabled",
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "trigger"
  ],
  "type": "object"
}