Skip to content
Start for free

Heap

Keep Heap off the page until visitors allow measurement. Calls that your code makes before heap.js is ready wait in a queue.

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
HeapWaiting for consent
Before a choice

No request goes to cdn.us.heap-api.com. In the Console, window.heap returns undefined.

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

Before you start

You need an Inth project that connects to your app, c15t in that app and the environment ID from your Heap installation snippet.

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 Heap

Before measurement has permission, c15t defines no window.heap and does not load heap_config.js. That file loads the heap.js runtime.

After permission, the helper creates window.heap with stubs for the heap.js v5 methods. Then it loads the config script. heap.js replays the queued calls when it is ready.

The helper never calls heap.stopTracking. On withdrawal, c15t removes the config script and reloads the page by default. The reload stops heap.js.

If you turn reloadOnConsentRevoked off, call window.heap.stopTracking() from a callback-only script.

Read about custom integrations

Installation

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

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

heap({ envId })

An opt-out policy or no policy gives optional categories permission before a choice. Then Heap 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 Heap.

    pnpm add @c15t/integrations

  2. Add your environment ID

    The helper sets the ID as heap.envId and heap.appid and loads heap_config.js for that environment.

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

export const scripts = [heap({ envId: 'YOUR_ENVIRONMENT_ID' })];

    An empty environment ID logs an error, and the script does not load. The helper always sets shouldFetchServerConfig to false.

  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 old Heap snippet, so Heap loads only through c15t. If you already have a scripts array, add the helper to it.

Verify your setup

Use a private window with an opt-in policy. Open DevTools Network and filter by heap. Then test the three states.

  • Before a choice

    No request goes to cdn.us.heap-api.com. In the Console, window.heap returns undefined.

  • After you allow measurement

    heap_config.js for your environment ID loads, and then the heap.js runtime. window.heap.envId holds your environment ID.

  • After you withdraw measurement

    Save your choice. c15t reloads the page. The new page sends no request to Heap.

Keep the reload on. Without it, heap.js continues to capture until the page unloads.

Open the full Heap guide