Skip to main content

WorkflowOut

idstring<uuid>required
nameName (string)required
description objectrequired
anyOf
string
statusStatus (string)required
nodesobject[]required
edgesobject[]required
created_atstring<date-time>required
updated_atstring<date-time>required
last_run objectrequired
anyOf
string
run_countRun Count (integer)required
success_rateSuccess Rate (number)required
user_idUser Id (string)required
workspace_id object
anyOf
string
versionVersion (integer)required
template_warnings object
anyOf
warningsstring[]required
suggestions objectrequired
property name*string
WorkflowOut
{
  "created_at": "2025-10-01T12:00:00Z",
  "description": "Sends a Slack message when a vehicle enters the warehouse zone",
  "edges": [
    {
      "id": "edge-1",
      "source": "trigger-1",
      "target": "action-1"
    }
  ],
  "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
  "last_run": "2025-10-01T14:30:00Z",
  "name": "Warehouse Entry Notification",
  "nodes": [
    {
      "data": {
        "config": {
          "geofence_ids": [
            "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
          ],
          "type": "geofence_enter"
        },
        "label": "Geofence Entry",
        "triggerType": "geofence_enter"
      },
      "id": "trigger-1",
      "position": {
        "x": 100,
        "y": 100
      },
      "type": "triggerGeofence"
    },
    {
      "data": {
        "actionType": "slack",
        "config": {
          "channel": "#dispatch",
          "message": "Vehicle {{device.name}} entered {{geofence.name}}"
        },
        "label": "Notify Dispatch"
      },
      "id": "action-1",
      "position": {
        "x": 400,
        "y": 100
      },
      "type": "actionSlack"
    }
  ],
  "run_count": 47,
  "status": "active",
  "success_rate": 97.8,
  "template_warnings": null,
  "updated_at": "2025-10-01T14:30:00Z",
  "user_id": "u1a2b3c4-d5e6-7890-abcd-ef1234567890",
  "version": 3,
  "workspace_id": "ws1a2b3c-d5e6-7890-abcd-ef1234567890"
}