Skip to main content

Product analytics

Pendo

Pendo records product usage and shows in-app guides. The c15t pendo helper waits until the measurement category is allowed before it downloads the Pendo agent, and it calls pendo.initialize() only once the agent has loaded and consent is still granted. Until then, c15t defines no pendo global.

When the visitor withdraws, the helper calls pendo.stopSendingEvents(). If consent comes back on the same page, it calls startSendingEvents() and keeps the same visitor identity. c15t still reloads the page by default.

Configure Pendo

Copy the web agent API key from Pendo. Then delete Pendo's install snippet from your app, and any tag manager copy, so Pendo can't load outside c15t. Pass visitor and account metadata only when your app has permission to identify the visitor.

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

export const scripts = [pendo({ apiKey: 'YOUR_API_KEY' })];

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
apiKeyRequiredWeb agent API key. Trimmed and URL-encoded into the default loader URL. If it's missing or blank, c15t logs an error and never loads Pendo.
visitorUnsetVisitor metadata passed to pendo.initialize(). Replaces any visitor in initializeOptions.
accountUnsetAccount metadata passed to pendo.initialize(). Replaces any account in initializeOptions.
initializeOptionsUnsetOther initialize() options, such as disableCookies, localStorageOnly, excludeAllText and cookieDomain.
categorymeasurementConsent category or condition that must be allowed before the agent loads.
scriptUrlhttps://cdn.pendo.io/agent/static/<apiKey>/pendo.jsCustom, regional or proxied agent URL. A blank value uses the default.

Loading and revocation

When the category is allowed, the helper adds the agent as an async script. It doesn't queue calls before the agent loads. After the script loads, it checks consent again and calls initialize() with your options. If the visitor withdrew while the agent was downloading, the helper doesn't initialize. It initializes on the next grant instead. Calling pendo() again with equal options, such as on a rerender, returns the same script, so Pendo initializes only once per page.

If the loaded script doesn't define window.pendo, for example because the API key or scriptUrl is wrong, the helper logs pendo: loader did not install the Pendo API and does nothing else. It doesn't throw.

On withdrawal, the helper keeps the agent on the page and calls stopSendingEvents(). On a later grant it calls startSendingEvents() and doesn't initialize a second time. This keeps the visitor's identity across reversible consent changes.

The helper never calls clearSession(), because that starts a new anonymous visitor and can send identification events. If a visitor signs out while Pendo is loaded and consent is granted, call pendo.clearSession() yourself before you identify the next visitor. Don't call it to withdraw consent, or while consent is denied. To remove data Pendo already collected, use your account's data deletion or Do Not Process controls.

Stopping events doesn't delete Pendo's cookies or local storage, and guides already on the page stay there. Keep reloadOnConsentRevoked enabled if the next page must run without Pendo loaded.

Cookies and storage

Pendo storage keys usually start with _pendo_ and include the app ID. Cookie behavior depends on initialize() options such as disableCookies, localStorageOnly and cookieDomain.

Verify Pendo

Filter the DevTools Network panel by pendo.io. Before consent, and with only an unrelated category allowed, check that no Pendo request, pendo global, cookie or storage entry appears. Allow measurement and confirm that the agent loads and initializes once. Withdraw consent and confirm the page reloads with Pendo blocked.

If you set reloadOnConsentRevoked: false, withdraw consent and check that pendo.isSendingEvents() returns false. Grant again and confirm that event sending resumes without a new anonymous visitor. Test guide behavior with your own account.

If the console shows pendo: loader did not install the Pendo API, check the API key and scriptUrl.

Sources: installation, collection prevention, event controls and cookies.

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 lists its vendor by name in the preference dialog, so 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.