CLItrail Docs

Add CLItrail to jQuery, Alpine.js and htmx pages

Where the CLItrail tag goes in jQuery, Alpine.js and htmx pages, in its own idiom, with the consent, CSP and client-side routing details and how to check it works.

Written for jQuery 4, Alpine.js 3, htmx 2

#Where the tag goes

Edit The <head> of your page template. Put the tag on every page that shows your install command; site-wide is best, after your existing analytics tags.

<head>
  <meta charset="utf-8" />
  <!-- …your analytics tags first -->
  <script defer src="https://YOUR_SERVICE/browser.js" data-website="YOUR_WEBSITE_ID"></script>
</head>

Use the loader in place of the tag: nothing from CLItrail loads until startClitrail() runs. Load the loader before your consent manager's script and call startClitrail() from the manager's accept callback (most managers also run it on later visits once a choice is stored; check yours). Use the marketing category when installs go to Google Ads, Meta, TikTok or X Ads, and the analytics category when they only reach GA4 or your webhooks.

Consent loader

// Loads CLItrail only after the visitor agrees. Call startClitrail() from your
// consent manager's "accepted" callback; nothing is fetched or stored before that.
window.startClitrail = () => {
  if (document.getElementById('clitrail')) return;
  const tag = document.createElement('script');
  tag.id = 'clitrail';
  tag.src = 'https://YOUR_SERVICE/browser.js';
  tag.dataset.website = 'YOUR_WEBSITE_ID';
  document.head.append(tag);
};
<head>
  <meta charset="utf-8" />
  <!-- …your analytics tags first -->
  <script defer src="/clitrail-consent.js"></script>
</head>

#Client-side routing

jQuery and Alpine.js pages load in full, so the tag is enough. htmx with hx-boost (or hx-push-url) swaps pages without a reload: record those on htmx:pushedIntoHistory, which htmx fires after it pushes the new URL.

// Records a visit when htmx pushes a new page URL (hx-boost, hx-push-url).
(() => {
  let recorded;
  const recordVisit = () => {
    recorded ??= new URL(performance.getEntriesByType('navigation')[0]?.name ?? location.href).pathname;
    const sdk = window.InstallAttribution;
    if (!sdk?.ready || location.pathname === recorded) return;
    recorded = location.pathname;
    sdk.ready = sdk.init({ service: 'https://YOUR_SERVICE', project: 'YOUR_WEBSITE_ID' });
  };
  document.addEventListener('htmx:pushedIntoHistory', recordVisit);
})();

#Content Security Policy

Your host's header settings (for example _headers on Cloudflare Pages or Netlify, vercel.json, or your server), or a <meta http-equiv="Content-Security-Policy"> tag: add https://YOUR_SERVICE to script-src and connect-src, and blob: to worker-src (only Safari before 26 needs that one).

script-src 'self' https://YOUR_SERVICE;
connect-src 'self' https://YOUR_SERVICE;
worker-src 'self' blob:;

#Verify it works

  1. Deploy, or open the page from your local server.
  2. Open a page with the tag in Chrome or Firefox (accept analytics first if you gate CLItrail on consent), open the developer console and run await InstallAttribution.ready. It resolves to { ok: true, urlId, hasAnalyticsContext, expiresAt }.
  3. In the CLItrail dashboard, open Visits & identities: the visit is listed.
  4. Anything else names the cause: disabled (no consent yet, or data-enabled="false"), opfs_unavailable (the page is not served over https or from localhost), Error (the service refused the visit: add the page's origin, including a development origin such as http://localhost:3000, under Settings → Additional domains). If InstallAttribution is undefined, the tag did not load: check the Network tab and your Content-Security-Policy.

Then run your installer on the same computer and check Install events, or run the hook with --doctor.

#Notes

The tag is independent of jQuery, Alpine.js and htmx; it has no dependencies.

jQuery, Alpine.js and htmx pages documentation: htmx.org/events

Using other install paths or destinations? The setup generator puts this snippet together with your hooks and destination checklist.