fixed links, tweaked text (#13844)

This commit is contained in:
Eron Donevan Powell
2022-06-10 13:25:07 -05:00
committed by GitHub
parent 2804b55875
commit cb93edcccd
3 changed files with 30 additions and 15 deletions

View File

@@ -6,13 +6,20 @@
[[toc]]
<!--
::: Before You Begin
:::tip Before You Begin
[Learn Directus](/getting-started/learn-directus)
Please be sure to read [Learn Directus](/getting-started/learn-directus).
:::
-->
:::tip Learn More
There is also dedicated API documentation on [Flows](/docs/reference/system/flows.md) and
[Operations](docs/reference/system/operations.md).
:::
## What's a Flow?
![What's a Flow?](https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/whats-a-flow-20220603A.webp)
@@ -28,13 +35,13 @@ ensure data is passed on as expected, a [console log](configuration/flows/operat
to help design and troubleshoot your Flows. Please see the documentation on
[Operations](/configuration/flows/operations) for more details.
Once a Flow is triggered, a [Flow JSON Object](#the-flow-object) is created which stores data from the Trigger event.
Then as each Operation in the flow executes, the data generated is added onto this Flow Object. Every Operation in a
Flow has access to this Flow Object.
Once a Flow is triggered, a [Flow Object](#the-flow-object) is created which stores data from the Trigger event. Then as
each Operation in the flow executes, the data generated is added onto this Flow Object. Every Operation in a Flow has
access to this Flow Object.
## Create a Flow
<video autoplay muted loop controls title="">
<video autoplay muted loop controls title="Create a Flow">
<source src="https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/create-a-flow-20220603A.mp4" type="video/mp4" />
</video>

View File

@@ -8,7 +8,7 @@
:::tip Before You Begin
Please be sure to read the documentation on [Flows](/configuration/flows/flows) and [Triggers](flows/triggers).
Please be sure to read the documentation on [Flows](/configuration/flows) and [Triggers](/configuration/flows/triggers).
:::
@@ -31,11 +31,11 @@ Creates some Item(s) in a Collection.
- **Collection** — Use the dropdown to select a Collection to create Items in.
- **Permissions** — Set the scope of permissions used for this Operation.
- **Emit Events** — Toggle whether the event is emitted.
- **Payload** — Create Item(s) in a Collection. To learn more, see [API > Items](reference/items/).
- **Payload** — Create Item(s) in a Collection. To learn more, see [API > Items](/reference/items/).
:::tip
Make sure the Operation is scoped with the [permissions](configuration/users-roles-permissions) necessary to create
Make sure the Operation is scoped with the [permissions](/configuration/users-roles-permissions) necessary to create
Items.
:::
@@ -53,7 +53,7 @@ Deletes some Item(s) from a Collection by ID or query.
:::tip
Make sure the Operation is scoped with the [permissions](configuration/users-roles-permissions) necessary to delete
Make sure the Operation is scoped with the [permissions](/configuration/users-roles-permissions) necessary to delete
Items.
:::
@@ -79,7 +79,7 @@ Updates Item(s) in a Collection. You may select Items by their ID or run a query
- **Permissions** — Defines Role that this Operation will inherit permissions from.
- **Collections** — Select the Collection to read Items from.
- **IDs** — Input ID for Item(s) you wish to read and press enter. Click the ID to remove.
- **Payload** — Updates Item(s) in a Collection. To learn more, see [API > Items](reference/items/).
- **Payload** — Updates Item(s) in a Collection. To learn more, see [API > Items](/reference/items/).
- **Query** — Select Items to update with a query. To learn more, see [Filter Rules](/configuration/filter-rules).
## Log to Console
@@ -89,7 +89,7 @@ Updates Item(s) in a Collection. You may select Items by their ID or run a query
Output something to the console. This will appear in both the server side and in-app Sidebar Console Log. This is a key
tool to help troubleshoot Flow configuration.
- **Message** — Sets a [log message](#configuration/flows/flows/logs).
- **Message** — Sets a [log message](/configuration/flows/#logs).
:::tip
@@ -121,8 +121,8 @@ provider may send it there automatically.
Sends a notification to an app user.
- **Users** — Defines a User by their primary key UUID. Use [Flow keys](/configuration/flows/flows/#the-flow-object) to
set this dynamically.
- **Users** — Defines a User by their primary key UUID. Use [Flow keys](/configuration/flows/#the-flow-object) to set
this dynamically.
- **Permissions** — Defines Role that this Operation will inherit permissions from.
- **Title** — Sets the notification title.
- **Message** — Sets the main body of the notification.

View File

@@ -1,9 +1,17 @@
# Triggers
> Each Flow is triggered by some internal or external event.
> Triggers allow you to activate Flows on just about any conceivable internal or external event, including any in-app
> activities, incoming webhooks, cron jobs, Operations in other Flows, or the manual click of a button in the Directus
> App.
[[toc]]
:::tip Before You Begin
Please be sure to read the documentation on [Flows](/configuration/flows).
:::
## Event Hook
![Event Hooks](https://cdn.directus.io/docs/v9/configuration/flows/triggers/triggers-20220603A/event-hook-20220602A.webp)