Workflow

object

idrequired: Id
Opaque record id.
namerequired: string
descriptionrequired: string or null
statusrequired: WorkflowStatus
active_versionrequired: integer or null
The live published version; null until published.
triggerrequired: object or null
trigger.eventrequired: string
trigger.labelrequired: string
reciperequired: object or null
recipe.keyrequired: string
recipe.versionrequired: integer
created_by_idrequired: Id or null
Opaque record id.
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
graphrequired: WorkflowGraph
settingsrequired: WorkflowSettings
published_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
has_unpublished_changesrequired: boolean
issuesrequired: array of WorkflowIssue
summaryrequired: array of string
The workflow in words, one line per step.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "name": "string",
  "description": "string",
  "status": "draft",
  "active_version": 0,
  "trigger": {
    "event": "string",
    "label": "string"
  },
  "recipe": {
    "key": "string",
    "version": 0
  },
  "created_by_id": "cmusrceel0000q7kaafxqi1om",
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z",
  "graph": {
    "format": 1,
    "nodes": [
      {
        "id": "string",
        "type": "string",
        "label": "string",
        "notes": "string",
        "position": {
          "x": 0,
          "y": 0
        },
        "config": {}
      }
    ],
    "edges": [
      {
        "id": "string",
        "source": "string",
        "target": "string",
        "handle": "string",
        "label": "string"
      }
    ]
  },
  "settings": {
    "reentry": {
      "mode": "once",
      "days": 1
    },
    "allow_concurrent_runs": true,
    "max_runs_per_entity_per_day": 0,
    "respect_quiet_hours": true,
    "alert_member_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "recipe": {
      "key": "string",
      "version": 0
    }
  },
  "published_at": "2026-10-06T05:30:00.000Z",
  "has_unpublished_changes": true,
  "issues": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "path": [
        "string"
      ],
      "node_id": "string",
      "edge_id": "string"
    }
  ],
  "summary": [
    "string"
  ]
}

{ "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "description": "string", "status": "draft", "active_version": 0, "trigger": { "event": "string", "label": "string" }, "recipe": { "key": "string", "version": 0 }, "created_by_id": "cmusrceel0000q7kaafxqi1om", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "graph": { "format": 1, "nodes": [ { "id": "string", "type": "string", "label": "string", "notes": "string", "position": { "x": 0, "y": 0 }, "config": {} } ], "edges": [ { "id": "string", "source": "string", "target": "string", "handle": "string", "label": "string" } ] }, "settings": { "reentry": { "mode": "once", "days": 1 }, "allow_concurrent_runs": true, "max_runs_per_entity_per_day": 0, "respect_quiet_hours": true, "alert_member_ids": [ "cmusrceel0000q7kaafxqi1om" ], "recipe": { "key": "string", "version": 0 } }, "published_at": "2026-10-06T05:30:00.000Z", "has_unpublished_changes": true, "issues": [ { "code": "string", "severity": "error", "message": "string", "path": [ "string" ], "node_id": "string", "edge_id": "string" } ], "summary": [ "string" ] }