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
Section titled “Settings”Configure all integrations as properties of the integrations object in your docs.json file:
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"
}
}Analytics
Section titled “Analytics”integrations.adobe(object) — Adobe Analytics integration.
integrations.adobe
launchUrl(string (uri), required) — Your Adobe Analytics launch URL.
integrations.amplitude(object) — Amplitude analytics integration.
integrations.amplitude
apiKey(string, required) — Your Amplitude API key.
integrations.clarity(object) — Microsoft Clarity session recording and heatmap integration.
integrations.clarity
projectId(string, required) — Your Microsoft Clarity project ID.
integrations.fathom(object) — Fathom analytics integration.
integrations.fathom
siteId(string, required) — Your Fathom site ID.
integrations.ga4(object) — Google Analytics 4 integration.
integrations.ga4
measurementId(string matching ^G, required) — Your Google Analytics 4 measurement ID. Must begin withG.
integrations.gtm(object) — Google Tag Manager integration.
integrations.gtm
tagId(string matching ^G, required) — Your Google Tag Manager container ID. Must begin withG.
integrations.heap(object) — Heap analytics integration.
integrations.heap
appId(string, required) — Your Heap app ID.
integrations.hightouch(object) — Hightouch data activation integration.
integrations.hightouch
writeKey(string, required) — Your Hightouch write key.apiHost(string) — Your Hightouch API host.
integrations.hotjar(object) — Hotjar heatmap and session recording integration.
integrations.hotjar
hjid(string, required) — Your Hotjar site ID.hjsv(string, required) — Your Hotjar script version.
integrations.logrocket(object) — LogRocket session replay integration.
integrations.logrocket
appId(string, required) — Your LogRocket app ID.
integrations.mixpanel(object) — Mixpanel product analytics integration.
integrations.mixpanel
projectToken(string, required) — Your Mixpanel project token.
integrations.pirsch(object) — Pirsch privacy-friendly analytics integration.
integrations.pirsch
id(string, required) — Your Pirsch site ID.
integrations.plausible(object) — Plausible privacy-friendly analytics integration.
integrations.plausible
domain(string, required) — Your Plausible domain.server(string) — Your Plausible server, if self-hosting.
integrations.posthog(object) — PostHog product analytics integration.
integrations.posthog
apiKey(string matching ^phc_, required) — Your PostHog API key. Must begin withphc_.apiHost(string (uri)) — Your PostHog API host. Required if self-hosting PostHog.sessionRecording(boolean) — Whether to enable session recording. Defaults tofalse.
integrations.segment(object) — Segment customer data platform integration.
integrations.segment
key(string, required) — Your Segment write key.cdnUrl(string) — A custom CDN URL for loading the Segment script. Must be an HTTPS URL without query parameters or fragments. Defaults tohttps://cdn.segment.com.
Chat and support
Section titled “Chat and support”integrations.frontchat(object) — Front chat widget integration.
integrations.frontchat
snippetId(string, required) — Your Front chat snippet ID. Minimum length: 6.
integrations.intercom(object) — Intercom customer messaging integration.
integrations.intercom
appId(string, required) — Your Intercom app ID. Minimum length: 6.
Data enrichment
Section titled “Data enrichment”integrations.clearbit(object) — Clearbit visitor data enrichment integration.
integrations.clearbit
publicApiKey(string, required) — Your Clearbit public API key.
Platform settings
Section titled “Platform settings”integrations.telemetry(object) — Mintlify telemetry settings.
integrations.telemetry
enabled(boolean) — Whether to enable Mintlify telemetry. When set tofalse, feedback features are also disabled and do not appear on your documentation pages.
integrations.cookies(object) — Cookie settings for your documentation site.
integrations.cookies
key(string) — Cookie key name.value(string) — Cookie value.
Example
Section titled “Example”"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"
},
"posthog": {
"apiKey": "phc_XXXXXXXXXX"
},
"intercom": {
"appId": "abc12345"
},
"telemetry": {
"enabled": true
}
}