> 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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ciusji.gitbook.io/darkseal/developers/web-hooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.