Skip to main content
Mintlify webhooks let agents respond to documentation build events.

​
Filter Fields (all optional)

FieldTypeDescription
projectsstring[]Only trigger for these Mintlify projects
eventsstring[]Mintlify event types (build, etc.)
actionsstring[]Event actions (failed, succeeded, etc.)
branchesstring[]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

# In project config.toml
[webhooks.mintlify-docs]
type = "mintlify"
credential = "docs-project"

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