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.adobeobject

Adobe Analytics integration.

Show integrations.adobe

launchUrlstring (uri)required

Your Adobe Analytics launch URL.

integrations.amplitudeobject

Amplitude analytics integration.

Show integrations.amplitude

apiKeystringrequired

Your Amplitude API key.

integrations.clarityobject

Microsoft Clarity session recording and heatmap integration.

Show integrations.clarity

projectIdstringrequired

Your Microsoft Clarity project ID.

integrations.fathomobject

Fathom analytics integration.

Show integrations.fathom

siteIdstringrequired

Your Fathom site ID.

integrations.ga4object

Google Analytics 4 integration.

Show integrations.ga4

measurementIdstring matching ^Grequired

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

integrations.gtmobject

Google Tag Manager integration.

Show integrations.gtm

tagIdstring matching ^Grequired

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

integrations.heapobject

Heap analytics integration.

Show integrations.heap

appIdstringrequired

Your Heap app ID.

integrations.hightouchobject

Hightouch data activation integration.

Show integrations.hightouch

writeKeystringrequired

Your Hightouch write key.

apiHoststring

Your Hightouch API host.

integrations.hotjarobject

Hotjar heatmap and session recording integration.

Show integrations.hotjar

hjidstringrequired

Your Hotjar site ID.

hjsvstringrequired

Your Hotjar script version.

integrations.logrocketobject

LogRocket session replay integration.

Show integrations.logrocket

appIdstringrequired

Your LogRocket app ID.

integrations.mixpanelobject

Mixpanel product analytics integration.

Show integrations.mixpanel

projectTokenstringrequired

Your Mixpanel project token.

integrations.pirschobject

Pirsch privacy-friendly analytics integration.

Show integrations.pirsch

idstringrequired

Your Pirsch site ID.

integrations.plausibleobject

Plausible privacy-friendly analytics integration.

Show integrations.plausible

domainstringrequired

Your Plausible domain.

serverstring

Your Plausible server, if self-hosting.

integrations.posthogobject

PostHog product analytics integration.

Show integrations.posthog

apiKeystring matching ^phc_required

Your PostHog API key. Must begin with phc_.

apiHoststring (uri)

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

sessionRecordingboolean

Whether to enable session recording. Defaults to false.

integrations.segmentobject

Segment customer data platform integration.

Show integrations.segment

keystringrequired

Your Segment write key.

Chat and support

integrations.frontchatobject

Front chat widget integration.

Show integrations.frontchat

snippetIdstringrequired

Your Front chat snippet ID. Minimum length: 6.

integrations.intercomobject

Intercom customer messaging integration.

Show integrations.intercom

appIdstringrequired

Your Intercom app ID. Minimum length: 6.

Data enrichment

integrations.clearbitobject

Clearbit visitor data enrichment integration.

Show integrations.clearbit

publicApiKeystringrequired

Your Clearbit public API key.

Platform settings

integrations.telemetryobject

Mintlify telemetry settings.

Show integrations.telemetry

enabledboolean

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

integrations.cookiesobject

Cookie settings for your documentation site.

Show integrations.cookies

keystring

Cookie key name.

valuestring

Cookie value.

Example

docs.json

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

Settings

Analytics

Chat and support

Data enrichment

Platform settings

Example

On this page