> For the complete documentation index, see [llms.txt](https://ciusji.gitbook.io/darkseal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ciusji.gitbook.io/darkseal/developers/web-hooks.md).

# Web Hooks

> A webhook is a way for an app to provide other applications with real-time information.

Darkseal supports 2 webhook types:

1. Generic
2. Slack

<figure><img src="/files/F44RMy9hFHYyifHax6cv" alt=""><figcaption></figcaption></figure>

## Setup A Generic Type Webhook

Path: **`Settings`** > **`Webhook`** > **`Add Webhook`**

Steps:

1. Add the name of the webhook
2. Describe the webhook
3. Enter the Consumer/client URL to consume the event's data
4. Can be used to activate or disable the webhook
5. Filters are provided for all the entities and for all the events. Event data for specific action can be achieved
6. Enter the batch size
7. Enter the desired connection timeout
8. A secret key can be used to secure the webhook connection

## Setup A Slack Type Webhook

Path: **`Settings`** > **`Slack`** > **`Add Slack`**

Steps:

1. Add the name of the webhook
2. Describe the webhook
3. Enter the Slack endpoint URL
4. Can be used to activate or disable the webhook
5. Filters are provided for all entities and for all events. Event data for specific actions can be achieved
6. Enter the batch size
7. Enter the desired connection timeout
8. A secret key can be used to secure the webhook connection
