Add an integration

Connect a third-party service to your docs site by adding a few lines to docs.json.

Mintlify integrations are configured in docs.json — no separate dashboard or plugin installation required. This guide covers the general pattern. See the pages in this section for provider-specific details.

Before you begin

• Your API key, tracking ID, or credentials from the service you want to connect
• Write access to your documentation repository

Steps

1. Get your credentials

   Log in to the service you’re connecting and find your API key, measurement ID, or project token. The exact location varies by provider — check the provider’s documentation under “API keys” or “Tracking.”

2. Add the integration to docs.json

   Open docs.json and add an integrations object if it doesn’t exist yet. Add your provider and credentials:

   "integrations": {
     "posthog": {
       "apiKey": "phc_your_key_here"
     }
   }
   

   For providers that need multiple fields (like Hotjar), the schema shows all required keys. See authentication for how Mintlify handles credentials.

3. Deploy

   Commit and push your updated docs.json. Mintlify deploys automatically and injects the integration script on every page.

4. Verify

   Visit your docs site and open your browser’s network tab. Confirm the provider’s script loaded and that events are appearing in the provider’s dashboard. Most providers show a real-time event stream you can use for verification.

You can add multiple integrations simultaneously. Each one listed in docs.json is loaded on every page of your site.

Next steps

• See supported analytics providers for analytics and session recording tools.
• Add a chat or support widget to let readers get help without leaving your docs.
• Use custom scripts for anything not covered by a built-in integration.