Skip to main content
Mintlify

Search documentation

Type to search this documentation.

On this pageOverview

Hightouch

Integrate Hightouch with your Mintlify documentation to sync analytics data for audience activation, segmentation, and downstream tool routing.

Before you connect Hightouch, you need a write key. Create an event source in your Hightouch workspace and copy its write key. See Hightouch's event sources documentation for setup steps.

Add the write key to your docs.json file to send analytics to Hightouch.

Analytics
"integrations": {
    "hightouch": {
        "writeKey": "required",
        "apiHost": "optional"
    }
}
Example
"integrations": {
    "hightouch": {
        "writeKey": "9132c81do371p76sr11da0075469b54f77649c9a067dp0303p56q0q64n072336",
        "apiHost": "us-east-1.hightouch-events.com"
    }
}
  • writeKey (string, required) — The write key from your Hightouch event source.

  • apiHost (string) — The Hightouch events API host, without https://. Defaults to us-east-1.hightouch-events.com.

After you deploy your changes, Mintlify sends engagement events such as page views and search queries to Hightouch. To confirm events are arriving, inspect live events in Hightouch's event debugger.

For an overview of the events Mintlify tracks, see Analytics integrations.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu