Docs presets and webhooks

This commit is contained in:
Ben Haynes
2020-10-06 17:18:52 -04:00
parent ff466c2bb7
commit acb062e18a
3 changed files with 43 additions and 8 deletions

View File

@@ -53,6 +53,15 @@ Collections can be organized in any way that is appropriate for your project. Yo
* [Creating a Collection](#)
* [Deleting a Collection](#)
## Presets
Presets store the exact state of a [collection detail](#) page. These are used to set layout defaults for a user, or to define bookmarks that can be used to quickly recall specific datasets.
### Relevant Guides
* [Creating a Preset](#)
* [Deleting a Preset](#)
## Fields
A Field is a specific type of value within a Collection. Each field represents a database column. Directus automatically uses a built-in [title formatter](#) to display your database column names prettified, and you can use [translations](#) to completely rename them if needed.

View File

@@ -1,6 +1,6 @@
# Presets & Bookmarks
# Collection Presets
> Presets define the default state of Collection Detail
> Presets store the exact state of a [collection detail](#) page. These can be used to set layout defaults for a user, or to define bookmarks that can be used to recall windows into specific datasets.
## Creating a Preset
@@ -15,12 +15,19 @@
After you have completed the form, the layout preview will be populated with live data. You can now tailor the layout as desired by updating the preview or the filter component in the page sidebar.
Each preset saves the following information for the collection/preset:
Each preset saves all of the information needed to recreate a view of the collection/layou, including: the full-text search query, any advanced filters added, sort field, sort direction, and all other specific layout options.
* **Search Query** — Any full-text search entered into the search bar
* **Filters**
* **Layout Query**
* **Layout Options**
::: Defaults vs Bookmarks
It's important to be aware of the difference between a collection's _defaults_ and its _bookmarks_, both of which are configured by presets. A _default_ is how a user will initially view the collection detail without any further customization, while a _bookmark_ is a named dataset that can be recalled at any point via the [collection navigation](#).
:::
::: System Defaults
You can also adjust the defaults and bookmarks for the Directus Activity, Directus Files, and Directus Users collections.
:::
::: Order of Defaults
Multiple defaults can be configured for a user, either for different layouts of even the same layout. In this case, the preset priority is: User, then Role, then Global.
:::
## Deleting a Preset

View File

@@ -1,13 +1,32 @@
# Webhooks
> TK
>
## Creating Webhooks
1. Navigate to **Settings > Webhooks**
2. Click the **Create Webhook** action button in the header
3. Complete the **other webhook form fields** outlined below
* **Name** — A name to help remember this webhooks purpose
* **Method** — Send as either a HTTP `GET` or `POST` request
* **URL** — The URL to send the request to
* **Status** — Whether the webhook is active (enabled) or inactive (disabled)
* **Data** — Whether the event's data should be sent along with the request
* **Trigger Actions** — The specific actions that will trigger the event
* **Trigger Collections** — The specific collections for which the above actions will trigger the event
## Disabling Webhooks
1. Navigate to **Settings > Webhooks > [Webhook]**
2. Set the **status field to inactive**
## Deleting Webhooks
1. Navigate to **Settings > Webhooks > [Webhook]**
2. Click the red **Delete Webhook** action button in the header
3. Confirm this decision by clicking **Delete** in the dialog
:::danger Irreversible Change
This action is permanent and can not be undone. Please proceed with caution.
:::