> ## Documentation Index
> Fetch the complete documentation index at: https://docs.actionllama.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Mintlify Webhooks

> Filter fields, setup, and examples for Mintlify webhook triggers

Mintlify webhooks let agents respond to documentation build events.

## Filter Fields (all optional)

| Field      | Type      | Description                              |
| ---------- | --------- | ---------------------------------------- |
| `projects` | string\[] | Only trigger for these Mintlify projects |
| `events`   | string\[] | Mintlify event types (build, etc.)       |
| `actions`  | string\[] | Event actions (failed, succeeded, etc.)  |
| `branches` | string\[] | Only for these branches                  |

## Setup

1. In Mintlify, go to your project settings
2. Navigate to **Webhooks** or **Integrations**
3. Add a webhook with URL: `https://your-server:8080/webhooks/mintlify`
4. Set the secret to match the `mintlify_webhook_secret` credential instance referenced by the webhook source in `config.toml`
5. Select build events you want to receive (build failures, successes, etc.)

## Example Configuration

```toml theme={null}
# In project config.toml
[webhooks.mintlify-docs]
type = "mintlify"
credential = "docs-project"
```

```toml theme={null}
# In agents/<name>/config.toml
[[webhooks]]
source = "mintlify-docs"
events = ["build"]
actions = ["failed"]
projects = ["my-docs"]
```