mirror of
https://github.com/directus/directus.git
synced 2026-01-30 05:58:03 -05:00
15b875728b
* Add configurable headers for webhooks * Update api/src/database/migrations/20211016A-add-webhook-headers.ts Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# Webhooks
|
|
|
|
> Webhooks are configured within the App (no code required) and send HTTP requests when a specific event is triggered.
|
|
> [Learn more about Webhooks](https://en.wikipedia.org/wiki/Webhook).
|
|
|
|
## 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
|
|
- **Request Headers** — Custom headers that will be added to the webhook request
|
|
- **Trigger Actions** — The specific actions that will trigger the event
|
|
- **Trigger Collections** — The specific collections for which the above actions will trigger events
|
|
|
|
## 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.
|
|
|
|
:::
|