mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2fd084c34b
* docs: clarify Hightouch setup with write key source and verification steps * docs: mirror Hightouch setup updates into fr, es, zh translations * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
55 lines
1.7 KiB
Plaintext
55 lines
1.7 KiB
Plaintext
---
|
|
title: "Hightouch"
|
|
description: "Integrate Hightouch with your Mintlify documentation to sync analytics data for audience activation, segmentation, and downstream tool routing."
|
|
keywords: ["Hightouch integration", "data activation", "write key", "audience sync"]
|
|
boost: 3
|
|
---
|
|
|
|
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](https://hightouch.com/docs/events/sources/overview) for setup steps.
|
|
|
|
Add the write key to your `docs.json` file to send analytics to Hightouch.
|
|
|
|
<Info>
|
|
|
|
Do not include `https://` for the `apiHost`.
|
|
|
|
</Info>
|
|
|
|
<CodeGroup>
|
|
|
|
```json Analytics options in docs.json
|
|
"integrations": {
|
|
"hightouch": {
|
|
"writeKey": "required",
|
|
"apiHost": "optional"
|
|
}
|
|
}
|
|
```
|
|
|
|
```json Example
|
|
"integrations": {
|
|
"hightouch": {
|
|
"writeKey": "9132c81do371p76sr11da0075469b54f77649c9a067dp0303p56q0q64n072336",
|
|
"apiHost": "us-east-1.hightouch-events.com"
|
|
}
|
|
}
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
## Configuration options
|
|
|
|
<ParamField path="writeKey" type="string" required>
|
|
The write key from your Hightouch event source.
|
|
</ParamField>
|
|
|
|
<ParamField path="apiHost" type="string">
|
|
The Hightouch events API host, without `https://`. Defaults to `us-east-1.hightouch-events.com`.
|
|
</ParamField>
|
|
|
|
## Verify the integration
|
|
|
|
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](https://hightouch.com/docs/events/sources/overview#debugger).
|
|
|
|
For an overview of the events Mintlify tracks, see [Analytics integrations](/integrations/analytics/overview).
|