Analytics

Hightouch

Configure Hightouch

Copy the write key from your Hightouch Event Source. Remove the original Hightouch snippet.

npm install @c15t/integrations@alpha

src/consent-scripts.ts

import { hightouch } from '@c15t/integrations/hightouch';

export const scripts = [hightouch({ writeKey: 'YOUR_WRITE_KEY' })];

Register the scripts

Complete your framework quickstart first. Keep its Inth endpoint, policy, styles and consent UI. Remove the vendor's original script, SDK initializer or tag-manager entry, so the vendor loads only through c15t.

The vendor pages put the helper in src/consent-scripts.ts. If your framework quickstart already has a scripts array, such as the one in c15t.config.ts in the Next.js guide, add the helper to that array instead of creating a second file. The scripts export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration point for your framework below. These are edits to that provider, not a second provider.

Add the configuration to scripts in c15t.config.ts, next to next.config.ts:

import { defineConsentConfig } from 'c15t/next';
import { scripts } from './src/consent-scripts';

export default defineConsentConfig({ scripts });

Keep the rest of your config, such as mode and routePrefix, in the same call. ConsentRoot reads the config in the browser, so the layout keeps passing only state. App Router, Pages Router and static export all read the same file. See Next.js scripts and embeds.

Options

Option	Default	Behavior
`writeKey`	Required	Event Source write key passed to `htevents.load`. The helper trims it. Empty values log an error and the script does not load.
`apiHost`	None	API host passed in the load options. Without it, the SDK uses `us-east-1.hightouch-events.com`. Set it only for another region or a first-party tracking host. A blank value is dropped.
`trackPageView`	`true`	Queues `htevents.page()` after `load`. Set `false` when your router sends page calls.
`scriptUrl`	`https://cdn.hightouch-events.com/browser/release/v1-latest/events.min.js`	Loader URL override. A blank value falls back to the default.

Loading and revocation

hightouch uses the measurement category. When measurement becomes allowed, the helper creates the window.htevents queue with the snippet's methods, stores the write key and load options on it, and queues load and, by default, page. Then it loads events.min.js, which replays the queue.

On revocation the helper removes the script element and calls no Hightouch API. An Event Source can forward events to other destinations, so check each destination's purpose in Hightouch as well.

Verify Hightouch

Filter DevTools Network by hightouch. After you allow measurement, events.min.js loads and a page event reaches your API host. With client-side routing, check that each route change sends one page event, not two. window.htevents still exists after revocation, so check measurement permission before your own htevents.track calls.

Test in a private window with an opt-in policy. Open DevTools Network, disable the cache and filter by the vendor's domain:

Load the page. No request goes to the vendor before you choose.
Click Reject, then reload. There is still no vendor request.
Open Privacy settings and allow the helper's category. The vendor script loads without a page reload.
Turn the category off again and save. c15t reloads the page, and the new page makes no vendor request.

c15t reloads on revocation because removing a script element does not stop code that already ran. The vendor's listeners, timers and queued events stay alive until the page unloads. If you set reloadOnConsentRevoked: false, stop the vendor yourself. Register a callback-only script whose onConsentChange calls the vendor's opt-out API, as shown in custom integrations, and check the permission before each of your own event calls. The reload does not delete cookies the vendor already set; see clear on revocation for your framework.

The helper sets vendor to its script ID, so once you declare that vendor a visitor can turn it off inside an allowed category. See vendor consent for your framework. The consent verification guide covers navigation, expiry and hosting checks.