Skip to content
Start for free

Hightouch

Collect customer events with Hightouch only from visitors who allow measurement. Until then, no htevents queue or SDK script exists on the page.

Inth keeps the consent record of each choice, with the visitor’s country and the policy that applied.

Start for free
pnpm add @c15t/integrations
HightouchWaiting for consent
Before a choice

Nothing loads from Hightouch, and no htevents queue exists.

Turn the switch on, then off, to see what loads.

Before you start

You need an Inth project that connects to your app and c15t in that app. You also need the write key from your Hightouch Event Source.

New to c15t? Complete the quickstart for your framework first. Keep its Inth endpoint, policy, styles and consent UI.

Open the quickstart for your framework

How consent works with Hightouch

When measurement becomes allowed, the c15t hightouch helper creates the window.htevents queue. It queues load and, by default, page.

Then the helper loads events.min.js, which replays the queue. The helper sends no consent signal to Hightouch.

On withdrawal, c15t removes the script element and calls no Hightouch API. By default, c15t also reloads the page.

An Event Source can send events to other destinations. So check the purpose of each destination in Hightouch too.

Installation

Hightouch has one load mode in c15t. The helper waits for measurement permission.

Wait for permission. No request goes to Hightouch until the visitor accepts measurement. On withdrawal, c15t removes the script and reloads the page.

hightouch({ writeKey })

An opt-out policy or no policy gives optional categories permission before a choice. Then Hightouch loads on the first page. This guide uses an opt-in policy.

Setup steps

  1. Install the integration package

    Add the helpers next to c15t. An import alone does not start the Hightouch Events SDK.

    pnpm add @c15t/integrations

  2. Add your write key

    The helper trims the key. An empty key logs an error, and the SDK does not load.

    src/consent-scripts.ts
    import { hightouch } from '@c15t/integrations/hightouch';

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

    Set apiHost only for another region or a first-party tracking host. Set trackPageView: false when your router sends page calls.

  3. Register it with your existing setup

    Add scripts to the c15t configuration that you have now. Keep your Inth endpoint, mode, policy, styles and consent UI.

    Add scripts to c15t.config.ts, next to next.config.ts. Keep the rest of your config, such as mode, in the same call. App Router, Pages Router and static export read the same file.

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

export default defineConsentConfig({ scripts });

    Pass scripts to the ConsentRoot in your root route. Import helpers in the route module, not in a server function: script configurations carry callbacks.

    src/routes/__root.tsx
    import { scripts } from '../consent-scripts';

<ConsentRoot state={consent} scripts={scripts}>

    Add scripts to the options of your ConsentProvider, next to mode. Keep the banner, dialog and preferences link inside the provider.

    src/consent.tsx
    import { scripts } from './consent-scripts';

<ConsentProvider options={{ mode, scripts }}>

    Register scripts under the c15t key in app.config.ts. Keep them out of nuxt.config.ts, which reaches the browser as JSON and drops the helper callbacks.

    app/app.config.ts
    import { scripts } from '../src/consent-scripts';

export default defineAppConfig({
  c15t: { scripts },
});

    Pass scripts to the c15tVue plugin call you have now. The plugin starts one script loader when the app mounts.

    src/main.ts
    import { c15tVue, manifest } from 'c15t/vue/vue-plugin';
import { scripts } from './consent-scripts';

app.use(c15tVue, {
  mode: manifest(),
  scripts,
});

    Add scripts to the client entrypoint, which the integration finds on its own. Keep helpers out of astro.config.mjs: its options are serialized into the page.

    src/c15t.client.ts
    import type { C15tClientOptionsExtension } from 'c15t/astro';
import { scripts } from './consent-scripts';

export default { scripts } satisfies C15tClientOptionsExtension;

    Pass scripts as a prop to the ConsentProvider you have now. The provider owns the loader and disposes it on unmount.

    src/App.svelte
    <script lang="ts">
  import { ConsentProvider, manifest } from 'c15t/svelte';
  import { scripts } from './consent-scripts';
</script>

<ConsentProvider mode={manifest()} {scripts}>
  <!-- Your app and consent UI -->
</ConsentProvider>

    Add scripts to the ConsentRoot in the root layout. Import helpers in the layout component, not in +layout.server.ts: a server load cannot send functions to the browser.

    src/routes/+layout.svelte
    <script lang="ts">
  import { ConsentRoot } from 'c15t/svelte';
  import { scripts } from '../consent-scripts';

  let { children, data } = $props();
</script>

<ConsentRoot state={data.consent} {scripts}>
  {@render children()}
</ConsentRoot>

    Paste the vendor’s snippet behind consent

    The helpers need a bundler. On a page with the c15t script tag, paste the vendor’s own snippet instead and keep it inert until visitors allow its category. Helper options, such as loadMode, do not apply.

    index.html
    <script type="text/plain" data-c15t-category="measurement">
  // The vendor's snippet, unchanged
</script>

    Pass scripts to init() from @c15t/browser, next to your mode. With createConsentRuntime, pass scripts to it instead.

    src/consent.ts
    import { init, manifest } from '@c15t/browser';
import { scripts } from './consent-scripts';

const consent = init({
  mode: manifest(),
  scripts,
});
All frameworks

Remove the original Hightouch snippet, so it cannot load without consent.

Verify your setup

Filter DevTools Network by hightouch. Then test the three states.

  • Before a choice

    Nothing loads from Hightouch, and no htevents queue exists.

  • After you allow measurement

    events.min.js loads, and a page event reaches your API host.

  • After you withdraw measurement

    c15t removes the script and reloads the page. The new page loads nothing from Hightouch.

window.htevents still exists after withdrawal on the same page. So check measurement permission before your own htevents.track calls.

Open the full Hightouch guide