Files
directus/docs/guides/webhooks.md
2020-10-07 13:17:07 -04:00

33 lines
1.3 KiB
Markdown

# Webhooks
> In addition to writing custom code for more complex [event hooks](#), 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
:::danger Irreversible Change
This action is permanent and can not be undone. Please proceed with caution.
:::