Email and SMS
Klaviyo
Configure Klaviyo
Copy the six-character public API key, also called the site ID, from
Settings > Account > API keys in Klaviyo. It appears in every page that
loads Klaviyo, so it is safe in browser code. Never put a private key
(pk_...) in the browser. If you pass one, the helper logs an error and
Klaviyo does not load.
Remove Klaviyo's own snippet first. On Shopify, BigCommerce, WooCommerce and the other platforms where Klaviyo installs Klaviyo.js for you, turn that installation off, or c15t is not the only thing loading it.
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:
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 |
|---|---|---|
publicApiKey | Required | Six-letter-or-digit public API key. Surrounding whitespace is trimmed. Any other value, including a missing key, logs an error and the script does not load. Private keys get their own message. |
mode | 'full' | 'full' loads forms and web tracking. 'forms-only' turns Klaviyo's web tracking off before the bundle starts; see forms-only mode. |
category | { and: ['marketing', 'measurement'] }, or 'marketing' in forms-only mode | Consent condition that must hold before Klaviyo.js loads. Accepts any category or and/or/not condition. |
scriptUrl | https://static.klaviyo.com/onsite/js/<publicApiKey>/klaviyo.js | Loader URL override, such as a first-party proxy. Must be https:. A blank value falls back to the default. |
Why Klaviyo needs two categories
One script, Klaviyo.js, serves both signup forms and Active on Site tracking.
Klaviyo offers no setting or browser API to load one without the other. Forms
grow your marketing lists, and tracking records which identified visitors are
on the site and feeds segments, attribution and automated email and SMS flows.
Klaviyo classifies its __kla_id cookie as a targeting cookie.
So by default klaviyo loads only when both marketing and measurement are
allowed. With either category alone, or neither, c15t requests nothing from
Klaviyo and Klaviyo writes no storage. Once the second category is allowed,
Klaviyo.js loads without a page reload, once.
If your legal review classifies Klaviyo differently, or your account uses only part of it, pass your own condition:
Forms-only mode
mode: 'forms-only' loads Klaviyo.js once marketing is allowed and sets
Klaviyo's __kla_off=true cookie before the bundle runs. Klaviyo documents
this cookie as the switch that keeps forms working while it stops tracking.
In this mode Klaviyo.js sends no Active on Site events, and identify and
track calls send nothing. It is not a cookieless mode:
- Klaviyo.js still writes an anonymous
__kla_idcookie, plus the Web Storage keys listed in storage. - Form views and steps are still reported to Klaviyo's form analytics, and
each report carries the anonymous visitor ID from
__kla_id. - Forms cannot target by visitor type, such as hiding a form from existing subscribers.
- A submission still creates the profile and records the subscription, but the browser stays unidentified, so Klaviyo records no onsite activity for that person afterwards.
- The mode is fixed when the page loads. Allowing measurement later does not
turn tracking on. Switch to
mode: 'full'in your configuration for that. __kla_offis a session cookie, and the helper never deletes it, since a site or visitor may also set it to opt out. If you move a site from forms-only to full mode, visitors who saw the forms-only version keep tracking off until they close the browser.
There is no measurement-only mode. Klaviyo cannot suppress published forms while still tracking visitors.
Vendor switches, opt-out regions and IAB mode
The helper sets the vendor slug klaviyo, so a visitor can allow marketing
and measurement and still switch Klaviyo off. Declare the vendor with a name
and privacy policy URL so your preference UI can show the switch; until then
c15t logs a warning in the console. See
vendor consent for your framework.
- With the switch off, Klaviyo.js does not load. Switching it off after Klaviyo has loaded reloads the page, and the new page loads nothing from Klaviyo.
clearOnRevocationruns per category, so switching off only the vendor leaves__kla_idand Klaviyo's other storage in place. Klaviyo stops reading them because it no longer loads.- In regions whose policy allows marketing and measurement before a choice, such as most of the US, Klaviyo.js loads on the first page view. A visitor sending Global Privacy Control has both denied, so Klaviyo does not load.
- In IAB TCF mode, vendor switches are ignored. Klaviyo has no TCF vendor ID in this helper, so it loads once the TCF purposes behind marketing (2, 3 and 4) and measurement (7, 8 and 9) are all granted.
Send your own events only with consent
The helper never calls identify, track or Klaviyo's Viewed Product and
Added to Cart snippets. Send them from your own code.
Before Klaviyo.js loads, the helper installs the klaviyo object from
Klaviyo's onsite snippet. Calls made before the bundle arrives are queued, and
Klaviyo.js replays them. The object exists only after the helper's consent
condition held on this page, so optional chaining drops calls made without
consent:
This check assumes c15t reloads the page on revocation, which it does by
default. With reloadOnConsentRevoked: false, the object stays after a
revocation, so check the categories with your framework's consent API before
each call. In forms-only mode, Klaviyo drops these calls even though the
object exists.
Account settings that change what Klaviyo collects
c15t controls when Klaviyo.js loads. These Klaviyo account settings control what it does once loaded:
- Anonymous visitor activity backfill stores frontend events for
unidentified visitors in local storage (
kl-post-identification-sync) for up to 14 days, then sends them when the visitor is identified. Klaviyo says this needs both analytics and marketing consent. Turn it off under Settings > Account > Data, Enable anonymous visitor tracking. - Extended ID and First-Party ID restore an identity after
__kla_idexpires; First-Party ID adds a__kle_idcookie. Klaviyo recommends updating your cookie notice before enabling either. - Email and SMS click tracking identifies visitors who arrive from a
Klaviyo message through the
_kxURL parameter. It can only be turned off for the whole account.
Cookie consent is not subscription consent
Your c15t banner asks whether Klaviyo may run in the browser. A Klaviyo signup form asks whether someone wants your emails or texts. They are separate records: allowing marketing cookies does not subscribe anyone, and a subscription does not grant cookie consent. Keep collecting email and SMS consent in Klaviyo forms, with the wording your channels require.
Storage Klaviyo writes
Observed with Klaviyo.js in October 2026. Klaviyo can change these names.
| Storage | Names |
|---|---|
| Cookies | __kla_id (up to two years after identification), __kle_id with First-Party ID, __kla_off in forms-only mode, datadome after a form submission triggers bot protection |
| Local storage | klaviyoOnsite, __kl_key, $referrer, $last_referrer, kl-post-identification-sync, ddSession |
| Session storage | klaviyoPagesVisitCountV2, klaviyoFormSubmit, _kx, ddCookieCandidateDomain |
The datadome and dd* names come from DataDome, the bot protection Klaviyo
runs on form submissions.
To delete them when a visitor turns either category off, add them to
clearOnRevocation under both categories:
See clear on revocation for your framework
for where the option goes. In forms-only mode, list the storage under
marketing only.
Content Security Policy
Klaviyo.js appends its modules as new script elements without a nonce. A popup signup form with default styling used these hosts in testing:
| Directive | Hosts |
|---|---|
script-src | https://static.klaviyo.com, https://static-tracking.klaviyo.com |
connect-src | https://a.klaviyo.com, https://fast.a.klaviyo.com, https://static-forms.klaviyo.com |
style-src | https://static.klaviyo.com, https://fonts.googleapis.com |
img-src | https://d3k81ch9hvuctc.cloudfront.net |
frame-src | https://geo.captcha-delivery.com, for the bot check some submissions get |
When DataDome, the bot protection Klaviyo runs on submissions, challenges a visitor, it loads its check in a frame. Fonts, images and features differ between forms, so test each published form under your policy.
Verify Klaviyo
Filter DevTools Network by klaviyo:
- Allow marketing only. Nothing loads from Klaviyo, and the Application tab
shows no
__kla_idcookie. - Allow measurement too.
klaviyo.jsloads fromstatic.klaviyo.com/onsite/js/<your key>/, followed by Klaviyo's modules fromstatic.klaviyo.comandstatic-tracking.klaviyo.com. - In full mode,
await klaviyo.account()in the console returns your public API key. In forms-only mode it returnsnull. - A published signup form appears in both modes. The form request goes to
static-forms.klaviyo.com/forms/api/v7/<your key>/full-forms. - In forms-only mode, the console shows Klaviyo's warning that tracking is
disabled, and an
identifycall sends no request toa.klaviyo.com/client/.
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.