Skip to main content
Webhooks let you receive real-time HTTP notifications whenever key events happen in your Mintlify project. Instead of polling for changes, your systems can react instantly when pages are published, updated, or deleted. You can use webhooks to trigger CI pipelines, update search indexes, notify external dashboards, or log activity in your own infrastructure.

​
Available events

​
Create a webhook endpoint

1

Open project settings

In the Mintlify dashboard, select your project and click Settings.
2

Go to the Webhooks tab

Navigate to Webhooks in the settings sidebar, then click Add endpoint.
3

Enter your endpoint URL

Provide the HTTPS URL where Mintlify should send event payloads. This must be a publicly accessible endpoint that can accept POST requests.
4

Select events to receive

Choose one or more events from the list above. You can subscribe to all events or limit notifications to only the ones your system needs.
5

Save and verify

Click Save. Mintlify sends a test payload to confirm the endpoint responds with a 2xx status code.

​
Sample webhook payload

Here is an example payload for a page.published event:
Always verify webhook signatures or use a secret token to authenticate requests. Mintlify includes a X-Mintlify-Signature header with every payload. Reject any request that does not include a valid signature to protect your endpoint from spoofed traffic.