Flows

Manage automation flows

Flows enable custom, event-driven data processing and task automation.

List Flows

GET /flows

Example:

curl "https://your-directus-instance.com/flows" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Flow

GET /flows/:id

Create Flow

POST /flows

Request Body:

{
  "name": "Send Welcome Email",
  "icon": "email",
  "color": "#6644FF",
  "status": "active",
  "trigger": "event",
  "options": {
    "type": "action",
    "scope": ["items.create"],
    "collections": ["users"]
  }
}

Update Flow

PATCH /flows/:id

Delete Flow

DELETE /flows/:id

Trigger Flow

Manually trigger a webhook flow:

POST /flows/trigger/:id
GET /flows/trigger/:id

Example:

curl -X POST "https://your-directus-instance.com/flows/trigger/flow-uuid" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "John"
    }
  }'

Flow Properties

id · string

Flow UUID

name · string

Flow name

status · string

active or inactive

trigger · string

Trigger type: event, webhook, schedule, manual, operation

options · object

Trigger-specific configuration

Next Steps

Operations

Manage flow operations

Flow Automation

Learn about flows