Skip to content
On this page

Webhooks

Webhooks are configured within the App (no code required) and send HTTP requests to an external service when a specific event is triggered.

WARNING

Webhooks are a deprecated feature and will be removed from the platform. This functionality has been fully replaced by Flows.

The Webhook Object

id integer
Primary key of the webhook.

name string
Name for the webhook. Shown in the Admin App.

method string
HTTP method to use. One of GET, POST.

url string
Where to send the request too.

status string
Status of the webhook. One of active, inactive.

data boolean
Whether or not to send the event data to the external endpoint.

actions csv
When to fire the webhook. Can contain create, update, delete.

collections csv
What collections to fire this webhook on.

json
{
	"data": {
		"id": 1,
		"name": "Build Website",
		"method": "POST",
		"url": "https://example.com/",
		"status": "active",
		"data": true,
		"actions": ["create", "update"],
		"collections": ["articles"]
	}
}
{
	"data": {
		"id": 1,
		"name": "Build Website",
		"method": "POST",
		"url": "https://example.com/",
		"status": "active",
		"data": true,
		"actions": ["create", "update"],
		"collections": ["articles"]
	}
}

List Webhooks

List all webhooks that exist in Directus.

Request

Query Parameters

Supports all global query parameters.

Response

An array of up to limit webhook objects. If no items are available, data will be an empty array.

Example

Retrieve a Webhook

List an existing webhook by primary key.

Request

Query Parameters

Supports all global query parameters.

Returns

Returns the requested webhook object.

Examples

Create a Webhook

Create a new webhook.

Request

Query Parameters

Supports all global query parameters.

Request Body

A partial webhook object.

name, actions, collections, and url are required.

Response

Returns the webhook object for the created webhook.

Example

Create Multiple Webhook

Create multiple new webhooks.

Request

Query Parameters

Supports all global query parameters.

Request Body

An array of partial webhook object.

name, actions, collections, and url are required.

Response

Returns the webhook objects for the created webhooks.

Example

Update a Webhook

Update an existing webhook.

Request

Query Parameters

Supports all global query parameters.

Request Body

A partial webhook object.

Response

Returns the webhook object for the updated webhook.

Example

Update Multiple Webhooks

Update multiple existing webhooks.

Request

Query Parameters

Supports all global query parameters.

Request Body

keys Required
Array of primary keys of the webhooks you'd like to update.

data Required
Any of the webhook object's properties.

Response

Returns the webhook objects for the updated webhooks.

REST API

Example

Delete a Webhook

Delete an existing webhook.

Request

Response

Empty body.

Example

Delete Multiple Webhooks

Delete multiple existing webhooks.

Request

Request Body

An array of webhook primary keys

Response

Empty body.

Example