Flows
Flows enable custom, event-driven data processing and task automation within Directus.
The Flow Object
id uuid
Primary key of the flow.
name string
Name for the flow.
icon string
Icon displayed in the Admin App for the flow.
color string
Color of the icon displayed in the Admin App for the flow.
description text
Short description displayed in the Admin App.
status string
Current status of the flow. One of active, inactive. Defaults to active when not specified.
trigger string
Type of trigger for the flow. One of event, webhook, operation, schedule, manual.
options json
Options of the selected trigger for the flow.
accountability string
The permission used during the flow. One of $public, $trigger, $full, or UUID of a role.
date_created timestamp
Timestamp in ISO8601 when the flow was created.
user_created many-to-one
The user who created the flow. Many-to-one to users.
operation string
UUID of the operation connected to the trigger in the flow.
{
"id": "2fab3b9d-0543-4b87-8a30-3c5ee66fedf1",
"name": "My Flow",
"icon": "bolt",
"color": "#112233",
"description": "Description for my flow",
"status": "active",
"trigger": "manual",
"accountability": "$trigger",
"date_created": "2022-05-11T13:14:52Z",
"user_created": "12e62fd0-29c7-4fd3-b3d3-c7a39933e8af",
"operation": "92e82998-e421-412f-a513-13701e83e4ce"
}{
"id": "2fab3b9d-0543-4b87-8a30-3c5ee66fedf1",
"name": "My Flow",
"icon": "bolt",
"color": "#112233",
"description": "Description for my flow",
"status": "active",
"trigger": "manual",
"accountability": "$trigger",
"date_created": "2022-05-11T13:14:52Z",
"user_created": "12e62fd0-29c7-4fd3-b3d3-c7a39933e8af",
"operation": "92e82998-e421-412f-a513-13701e83e4ce"
}List Flows
List all flows that exist in Directus.
Request
Query Parameters
Supports all global query parameters.
Response
An array of up to limit flow objects. If no items are available, data will be an empty array.
Example
Retrieve a flow
List an existing flow by primary key.
Request
Query Parameters
Supports all global query parameters.
Response
Returns the requested flow object.
Example
Create a Flow
Create a new flow.
Request
Query Parameters
Supports all global query parameters.
Request Body
A partial flow object.
Response
Returns the flow object for the created flow.
Example
Create Multiple Flows
Create multiple new flows.
Request
Query Parameters
Supports all global query parameters.
Request Body
An array of partial flow objects.
Response
Returns the flow object for the created flow.
Example
Update a Flow
Update an existing flow.
Request
Query Parameters
Supports all global query parameters.
Request Body
A partial flow object.
Response
Returns the flow object for the updated flow.
Example
Update Multiple Flows
Update multiple existing flows.
Request
Query Parameters
Supports all global query parameters.
Request Body
keys Required
Array of primary keys of the flows you'd like to update.
data Required
Any of the flow object's properties.
Response
Returns the flow objects for the updated flows.
Example
Delete a Flow
Delete an existing flow.
Request
Response
Empty body.
Example
Delete Multiple Flows
Delete multiple existing flows.
Request
Request Body
An array of flows primary keys
Response
Empty body.
Example
Flow with GET webhook trigger
Start a flow with GET webhook trigger.
Request
Response
Result of the flow, if any.
Example
Flow with POST webhook trigger
Start a flow with POST webhook trigger.
Request
Request Body
Payload for the POST request.
Response
Result of the flow, if any.