Files
directus/docs/guides/webhooks.md
Ben Haynes f862f0f8f3 More docs! (#3953)
* Add Quickstart Guide

* Update installation

* Remove unused files

* Update support/backing

* Tweaks in concepts

* Setup file structure for API reference 2.0

* Setup page layout for reference

* Add clean-urls plugin

* getting started updates

* Finish authentication rest

* getting started updates

* Render stylus in 2 spaces

* Various

* Various

* Finish activity docs

* Add collections reference

* Add extension reference

* concepts updates

* Fields/tweaks

* Add files doc

* Add revisions

* concepts docs

* More api reference

* Finish rest api reference (finally)

* initial concepts

* More things

* Add assets api ref

* Move sections from file to assets

* Add environment variables

* contributing docs

* Add field transforms page

* Left align table headers

* concept links

* Add API config

* Fix mobile nav

* Add migrating a project

* doc link fixes

* link fixes

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-02-05 21:31:39 -05:00

1.3 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 > 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.

:::