Files
directus/docs/configuration/webhooks.md
Nitwel 1e37429d7e Make docs a lot more fancy. (#10898)
* add images to content, file-library and user-directory pages of docs

* turn buttons from png to inline html and replace gifs with mp4s

* add a ton of icons everywhere

* add icons to presets & bookmarks

* add icons to webhooks

* add icons and clean up quickstart guide

* clean up icons and videos

* Move video assets to CDN

* Use updated video file naming system

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-01-29 12:25:54 -05:00

1.5 KiB

Webhooks

Webhooks are configured within the App (no code required) and send HTTP requests when a specific event is triggered. Learn more about Webhooks.

Creating Webhooks

  1. Navigate to Settings chevron_right Webhooks
  2. Click add 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 chevron_right Webhooks chevron_right [Webhook]
  2. Set the status field to inactive

Deleting Webhooks

  1. Navigate to Settings chevron_right Webhooks chevron_right [Webhook]
  2. Click delete 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.

:::