Integrations

Connect analytics platforms, chat widgets, and third-party services to your Mintlify documentation site through the docs.json integrations config.

Use the integrations field in docs.json to connect third-party analytics platforms, chat tools, and other services to your documentation site.

Settings

Configure all integrations as properties of the integrations object in your docs.json file:

docs.json

"integrations": {
  "ga4": {
    "measurementId": "G-XXXXXXXXXX"
  }
}

Analytics

integrations.adobe · object

Adobe Analytics integration.

Show integrations.adobe

launchUrl · string (uri) · required

Your Adobe Analytics launch URL.

integrations.amplitude · object

Amplitude analytics integration.

Show integrations.amplitude

apiKey · string · required

Your Amplitude API key.

integrations.clarity · object

Microsoft Clarity session recording and heatmap integration.

Show integrations.clarity

projectId · string · required

Your Microsoft Clarity project ID.

integrations.fathom · object

Fathom analytics integration.

Show integrations.fathom

siteId · string · required

Your Fathom site ID.

integrations.ga4 · object

Google Analytics 4 integration.

Show integrations.ga4

measurementId · string matching ^G · required

Your Google Analytics 4 measurement ID. Must begin with G.

integrations.gtm · object

Google Tag Manager integration.

Show integrations.gtm

tagId · string matching ^G · required

Your Google Tag Manager container ID. Must begin with G.

integrations.heap · object

Heap analytics integration.

Show integrations.heap

appId · string · required

Your Heap app ID.

integrations.hightouch · object

Hightouch data activation integration.

Show integrations.hightouch

writeKey · string · required

Your Hightouch write key.

apiHost · string

Your Hightouch API host.

integrations.hotjar · object

Hotjar heatmap and session recording integration.

Show integrations.hotjar

hjid · string · required

Your Hotjar site ID.

hjsv · string · required

Your Hotjar script version.

integrations.logrocket · object

LogRocket session replay integration.

Show integrations.logrocket

appId · string · required

Your LogRocket app ID.

integrations.mixpanel · object

Mixpanel product analytics integration.

Show integrations.mixpanel

projectToken · string · required

Your Mixpanel project token.

integrations.pirsch · object

Pirsch privacy-friendly analytics integration.

Show integrations.pirsch

id · string · required

Your Pirsch site ID.

integrations.plausible · object

Plausible privacy-friendly analytics integration.

Show integrations.plausible

domain · string · required

Your Plausible domain.

server · string

Your Plausible server, if self-hosting.

integrations.posthog · object

PostHog product analytics integration.

Show integrations.posthog

apiKey · string matching ^phc_ · required

Your PostHog API key. Must begin with phc_.

apiHost · string (uri)

Your PostHog API host. Required if self-hosting PostHog.

sessionRecording · boolean

Whether to enable session recording. Defaults to false.

integrations.segment · object

Segment customer data platform integration.

Show integrations.segment

key · string · required

Your Segment write key.

Chat and support

integrations.frontchat · object

Front chat widget integration.

Show integrations.frontchat

snippetId · string · required

Your Front chat snippet ID. Minimum length: 6.

integrations.intercom · object

Intercom customer messaging integration.

Show integrations.intercom

appId · string · required

Your Intercom app ID. Minimum length: 6.

Data enrichment

integrations.clearbit · object

Clearbit visitor data enrichment integration.

Show integrations.clearbit

publicApiKey · string · required

Your Clearbit public API key.

Platform settings

integrations.telemetry · object

Mintlify telemetry settings.

Show integrations.telemetry

enabled · boolean

Whether to enable Mintlify telemetry. When set to false, feedback features are also disabled and do not appear on your documentation pages.

integrations.cookies · object

Cookie settings for your documentation site.

Show integrations.cookies

key · string

Cookie key name.

value · string

Cookie value.

Example

docs.json

"integrations": {
  "ga4": {
    "measurementId": "G-XXXXXXXXXX"
  },
  "posthog": {
    "apiKey": "phc_XXXXXXXXXX"
  },
  "intercom": {
    "appId": "abc12345"
  },
  "telemetry": {
    "enabled": true
  }
}