mirror of
https://github.com/directus/directus.git
synced 2026-02-01 11:45:02 -05:00
38 lines
1.4 KiB
Markdown
38 lines
1.4 KiB
Markdown
# Webhooks
|
|
|
|
> In addition to writing custom code for more complex [event hooks](/concepts/api-extensions),
|
|
> Directus provides a way to quickly configure webhooks through the App. These send HTTP requests
|
|
> when a specific event is triggered within the project.
|
|
|
|
## 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
|
|
|
|
<!-- prettier-ignore-start -->
|
|
::: danger Irreversible Change
|
|
This action is permanent and can not be undone. Please proceed with caution.
|
|
:::
|
|
<!-- prettier-ignore-end -->
|