> For the complete documentation index, see [llms.txt](https://epsilla-inc.gitbook.io/epsilladb/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://epsilla-inc.gitbook.io/epsilladb/knowledge-base/advanced-settings/webhook.md).

# Webhook

The Webhook is used to receive updates on the status of knowledge base data processing. It provides an effective way to integrate with an enterprise's in-house data processing pipeline, allowing for real-time monitoring and automation of workflows based on processing events.

Provide an endpoint where Epsilla should post status updates:

<figure><img src="/files/0w2bfQUL325bvT2r7gXJ" alt=""><figcaption></figcaption></figure>

When the data processing starts, Epsilla will POST the following payload to your webhook endpoint:

```json
{
    "datasourceid": <DataSourceID>,
    "timestamp": 1716414820.557603,
    "detail": {
        "status": "processing"
    }
}
```

When the data processing finishes, Epsilla will POST the following payload to your webhook endpoint:

```json
{
    "datasourceid": <DataSourceID>,
    "timestamp": 1716414812.8154922,
    "detail": {
        "status": "ready"
    }
}
```

The DataSourceID is an identifier for your knowledge base's data source. You can obtain the data source ID from the URL, specifically from the last parameter of the link.

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


---

# 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://epsilla-inc.gitbook.io/epsilladb/knowledge-base/advanced-settings/webhook.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.
