Skip to main content

Analytics

Hotjar

Configure Hotjar

Copy the site ID from your Hotjar tracking code, where it is the hjid value. Remove the original tracking code.

npm install @c15t/integrations@alpha
src/consent-scripts.ts
import { hotjar } from '@c15t/integrations/hotjar';

export const scripts = [hotjar({ siteId: 1234567 })];

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

OptionDefaultBehavior
siteIdRequiredSite ID as a number or string. Set as window._hjSettings.hjid and used in the default loader URL. Missing, empty and 0 values log an error and the script does not load.
version6Script version, set as window._hjSettings.hjsv and the sv query parameter of the default loader URL.
scriptUrlhttps://static.hotjar.com/c/hotjar-<siteId>.js?sv=<version>Loader URL override.

Loading and revocation

hotjar uses the measurement category. When measurement becomes allowed, the helper sets window._hjSettings and a queue-backed window.hj stub, each only when the global is undefined, then loads the Hotjar loader.

On revocation the helper removes the loader script element and calls no Hotjar API. A recording in progress continues until the page unloads, so c15t's default reload on revocation is what ends it.

Verify Hotjar

Filter DevTools Network by hotjar. After you allow measurement, the hotjar-<siteId>.js request loads from static.hotjar.com, and window._hjSettings.hjid holds your site ID. Review a recording of a real screen in your app to check that Hotjar masks the fields you expect. window.hj still exists after revocation, so check measurement permission before your own hj calls.

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

  1. Load the page. No request goes to the vendor before you choose.
  2. Click Reject, then reload. There is still no vendor request.
  3. Open Privacy settings and allow the helper's category. The vendor script loads without a page reload.
  4. 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.