@c15t/react 3.2.0-canary.0 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/AGENTS.md +33 -10
  2. package/README.md +5 -7
  3. package/dist/styles.tw3.css +2 -2
  4. package/dist/version.js +1 -1
  5. package/dist-types/version.d.ts +1 -1
  6. package/docs/README.md +33 -10
  7. package/docs/concepts/choose-your-setup.md +8 -9
  8. package/docs/concepts/modes.md +5 -3
  9. package/docs/customization/stylesheets.md +39 -0
  10. package/docs/frameworks/react/hooks.md +2 -1
  11. package/docs/frameworks/react/quickstart.md +3 -3
  12. package/docs/frameworks/react/upgrade-v3.md +2 -2
  13. package/docs/integrations/activecampaign.md +297 -0
  14. package/docs/integrations/ada.md +396 -0
  15. package/docs/integrations/adobe-target.md +460 -0
  16. package/docs/integrations/adroll.md +336 -0
  17. package/docs/integrations/amazon-ads.md +424 -0
  18. package/docs/integrations/appcues.md +368 -0
  19. package/docs/integrations/attentive.md +313 -0
  20. package/docs/integrations/building-integrations.md +29 -16
  21. package/docs/integrations/clearbit.md +1 -1
  22. package/docs/integrations/customer-io.md +369 -0
  23. package/docs/integrations/databuddy.md +139 -50
  24. package/docs/integrations/default-com.md +497 -0
  25. package/docs/integrations/dynamic-yield.md +373 -0
  26. package/docs/integrations/fullstory.md +298 -0
  27. package/docs/integrations/gainsight-px.md +418 -0
  28. package/docs/integrations/gorgias.md +365 -0
  29. package/docs/integrations/hubspot.md +529 -0
  30. package/docs/integrations/insider.md +550 -0
  31. package/docs/integrations/liveintent.md +327 -0
  32. package/docs/integrations/lucky-orange.md +336 -0
  33. package/docs/integrations/marketo.md +309 -0
  34. package/docs/integrations/optimizely.md +411 -0
  35. package/docs/integrations/oracle-eloqua.md +301 -0
  36. package/docs/integrations/overview.md +124 -111
  37. package/docs/integrations/pendo.md +339 -0
  38. package/docs/integrations/rb2b.md +363 -0
  39. package/docs/integrations/salesforce-pardot.md +342 -0
  40. package/docs/integrations/statable-analytics.md +345 -0
  41. package/docs/integrations/the-trade-desk.md +328 -0
  42. package/docs/integrations/vector.md +333 -0
  43. package/docs/integrations/wisepops.md +416 -0
  44. package/docs/integrations/zendesk.md +359 -0
  45. package/package.json +8 -8
  46. package/docs/integrations/other-ads-and-pixels.md +0 -94
  47. package/docs/integrations/other-analytics.md +0 -108
  48. package/docs/integrations/other-chat-and-support.md +0 -112
  49. package/docs/integrations/other-email-and-sms.md +0 -156
  50. package/docs/integrations/other-experience.md +0 -222
@@ -0,0 +1,301 @@
1
+ ---
2
+ title: Oracle Eloqua
3
+ description: Load Oracle Eloqua after mapped category and vendor consent,
4
+ configure its tracking settings, and verify loading and withdrawal with c15t.
5
+ seoTitle: Oracle Eloqua cookie consent with c15t
6
+ seoDescription: Gate Oracle Eloqua on category and vendor consent with c15t.
7
+ Configure the loader, understand withdrawal limits, and verify vendor requests
8
+ and storage.
9
+ icon: chart-line
10
+ group: integrations
11
+ ---
12
+
13
+ `eloquaTracking` waits for its mapped category and vendor consent before creating vendor globals or downloading Oracle Eloqua. The default category is `marketing`.
14
+
15
+ ## Configure Oracle Eloqua
16
+
17
+ Copy your site ID from Eloqua and remove the original asynchronous tracking snippet. Configure a first-party tracking hostname in Eloqua before setting `firstPartyCookieDomain`.
18
+
19
+ | Package manager | Command |
20
+ | :-------------- | :------------------------------- |
21
+ | npm | `npm install @c15t/integrations` |
22
+ | pnpm | `pnpm add @c15t/integrations` |
23
+ | yarn | `yarn add @c15t/integrations` |
24
+ | bun | `bun add @c15t/integrations` |
25
+
26
+ ```ts title="src/consent-scripts.ts"
27
+ import { eloquaTracking } from '@c15t/integrations/oracle-eloqua';
28
+
29
+ export const scripts = [eloquaTracking({ siteId: 'YOUR_SITE_ID' })];
30
+ ```
31
+
32
+ ## Register the scripts
33
+
34
+ Complete your [framework quickstart](https://c15t.com/docs/frameworks) first. Keep its Inth
35
+ endpoint, policy, styles and consent UI. Remove the vendor's original script,
36
+ SDK initializer or tag-manager entry, so the vendor loads only through c15t.
37
+
38
+ The vendor pages put the helper in `src/consent-scripts.ts`. If your framework
39
+ quickstart already has a `scripts` array, such as the one in `c15t.config.ts`
40
+ in the Next.js guide, add the helper to that array instead of creating a
41
+ second file.
42
+ The `scripts` export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration
43
+ point for your framework below. These are edits to that provider, not a second
44
+ provider.
45
+
46
+ **Next.js**
47
+
48
+ Add the configuration to `scripts` in `c15t.config.ts`, next to
49
+ `next.config.ts`:
50
+
51
+ ```ts title="c15t.config.ts"
52
+ import { defineConsentConfig } from 'c15t/next';
53
+ import { scripts } from './src/consent-scripts';
54
+
55
+ export default defineConsentConfig({ scripts });
56
+ ```
57
+
58
+ Keep the rest of your config, such as `mode` and `routePrefix`, in the
59
+ same call. `ConsentRoot` reads the config in the browser, so the layout
60
+ keeps passing only `state`. App Router, Pages Router and static export all
61
+ read the same file. See
62
+ [Next.js scripts and embeds](https://c15t.com/docs/frameworks/next/scripts).
63
+
64
+ **TanStack Start**
65
+
66
+ Import the configuration into your root route and pass it to the existing
67
+ `ConsentRoot` as a top-level prop. Keep the loader from the
68
+ [TanStack Start quickstart](https://c15t.com/docs/frameworks/tanstack-start/quickstart):
69
+
70
+ ```tsx title="src/routes/__root.tsx"
71
+ import { scripts } from '../consent-scripts';
72
+
73
+ <ConsentRoot state={consent} scripts={scripts}>
74
+ ```
75
+
76
+ Import vendor helpers in the root route module, not in a server function.
77
+ A server function's return value must be serializable, and script
78
+ configurations carry callbacks. See
79
+ [TanStack Start scripts](https://c15t.com/docs/frameworks/tanstack-start/scripts).
80
+
81
+ **React**
82
+
83
+ Add the configuration to the existing `ConsentProvider` options, next to
84
+ `mode`:
85
+
86
+ ```tsx title="src/consent.tsx"
87
+ import { scripts } from './consent-scripts';
88
+
89
+ <ConsentProvider options={{ mode, scripts }}>
90
+ ```
91
+
92
+ `mode` is the `manifest()` value from the
93
+ [React quickstart](../frameworks/react/quickstart.md). Keep the banner,
94
+ dialog and preferences link inside the provider. See
95
+ [React scripts and embeds](../frameworks/react/scripts.md).
96
+
97
+ **Nuxt**
98
+
99
+ Register the scripts under the `c15t` key in `app/app.config.ts`. Adjust the
100
+ relative import to where you created `consent-scripts.ts`:
101
+
102
+ ```ts title="app/app.config.ts"
103
+ import { scripts } from '../src/consent-scripts';
104
+
105
+ export default defineAppConfig({
106
+ c15t: { scripts },
107
+ });
108
+ ```
109
+
110
+ The Nuxt module merges this over its options in `nuxt.config.ts` and starts
111
+ one script loader in the browser after hydration, once it has applied the
112
+ visitor's stored choice and privacy signals. Keep `scripts` out of
113
+ `nuxt.config.ts`, which reaches the browser as JSON and drops the vendor
114
+ callbacks. Write the vendor IDs into `consent-scripts.ts`. See
115
+ [Nuxt scripts and embeds](https://c15t.com/docs/frameworks/nuxt/scripts).
116
+
117
+ **Vue**
118
+
119
+ Pass the scripts to the existing `c15tVue` plugin call in `src/main.ts`:
120
+
121
+ ```ts title="src/main.ts"
122
+ import { c15tVue, manifest } from 'c15t/vue/vue-plugin';
123
+ import { scripts } from './consent-scripts';
124
+
125
+ app.use(c15tVue, {
126
+ mode: manifest(),
127
+ scripts,
128
+ });
129
+ ```
130
+
131
+ Keep your existing `mode` and other options. The plugin starts one
132
+ script loader when the app mounts, after it has applied the visitor's stored
133
+ choice. Do not also call `createScriptLoader` from a component. See
134
+ [Vue scripts and embeds](https://c15t.com/docs/frameworks/vue/scripts).
135
+
136
+ **Astro**
137
+
138
+ Add the scripts to the client entrypoint from the
139
+ [Astro quickstart](https://c15t.com/docs/frameworks/astro/quickstart), `src/c15t.client.ts`,
140
+ which the integration finds on its own. Keep `astro.config.mjs` as it is.
141
+ If the module already exports scripts, combine the two arrays.
142
+
143
+ ```ts title="src/c15t.client.ts"
144
+ import type { C15tClientOptionsExtension } from 'c15t/astro';
145
+ import { scripts } from './consent-scripts';
146
+
147
+ export default { scripts } satisfies C15tClientOptionsExtension;
148
+ ```
149
+
150
+ Vendor helpers contain callbacks, and the integration options in
151
+ `astro.config.mjs` are serialized into the page, so do not put helpers in
152
+ the integration's `scripts` option. The integration passes the client
153
+ entrypoint to the one runtime every page shares, including across
154
+ `ClientRouter` navigation.
155
+
156
+ **Svelte**
157
+
158
+ Import the scripts in the component that owns your existing provider and
159
+ pass them as a top-level prop:
160
+
161
+ ```svelte title="src/App.svelte"
162
+ <script lang="ts">
163
+ import { ConsentProvider, manifest } from 'c15t/svelte';
164
+ import { scripts } from './consent-scripts';
165
+ </script>
166
+
167
+ <ConsentProvider mode={manifest()} {scripts}>
168
+ <!-- Keep your application, consent UI and preferences link here. -->
169
+ </ConsentProvider>
170
+ ```
171
+
172
+ Retain the styles and consent UI from the [Svelte quickstart](https://c15t.com/docs/frameworks/svelte/quickstart).
173
+ The provider owns the loader and disposes it on unmount.
174
+
175
+ **SvelteKit**
176
+
177
+ Add the scripts to the existing `ConsentRoot` in the root layout. Keep the
178
+ handle and the layout load from the [SvelteKit quickstart](https://c15t.com/docs/frameworks/sveltekit/quickstart).
179
+
180
+ ```svelte title="src/routes/+layout.svelte"
181
+ <script lang="ts">
182
+ import { ConsentRoot } from 'c15t/svelte';
183
+ import { scripts } from '../consent-scripts';
184
+
185
+ let { children, data } = $props();
186
+ </script>
187
+
188
+ <ConsentRoot state={data.consent} {scripts}>
189
+ {@render children()}
190
+ <!-- Keep your consent UI and preferences link here. -->
191
+ </ConsentRoot>
192
+ ```
193
+
194
+ Import vendor helpers in the layout component, not in `+layout.server.ts`:
195
+ a server load cannot send functions to the browser. Prerendered, static and
196
+ SPA-mode pages use the same `scripts` prop. If you pass an externally owned
197
+ `runtime` to the provider, register scripts when creating that runtime instead.
198
+
199
+ **HTML**
200
+
201
+ The helpers in `@c15t/integrations` are ES modules that need a bundler. On a
202
+ page that loads the c15t script tag, paste the vendor's own snippet instead
203
+ and keep it inert until its category is allowed:
204
+
205
+ ```html
206
+ <script type="text/plain" data-c15t-category="measurement">
207
+ // The vendor's snippet, unchanged
208
+ </script>
209
+ ```
210
+
211
+ Use the category this guide names for the vendor. c15t runs the snippet
212
+ once that category is allowed, and reloads the page when the visitor
213
+ withdraws it. Helper options on this page, such as `loadMode`, do not apply
214
+ to a pasted snippet. See [HTML scripts](https://c15t.com/docs/frameworks/html/scripts).
215
+
216
+ **JavaScript**
217
+
218
+ Pass the scripts to `init()` from `@c15t/browser`, next to your mode:
219
+
220
+ ```ts
221
+ import { init, manifest } from '@c15t/browser';
222
+ import { scripts } from './consent-scripts';
223
+
224
+ const consent = init({
225
+ mode: manifest(),
226
+ scripts,
227
+ });
228
+ ```
229
+
230
+ Keep the mode from your quickstart. With
231
+ `createConsentRuntime` from `c15t/runtime`, pass `scripts` to it instead.
232
+ A kernel you create yourself needs a loader from
233
+ `c15t/modules/script-loader`. Attach one loader per kernel. See
234
+ [JavaScript scripts](https://c15t.com/docs/frameworks/javascript/scripts).
235
+
236
+ ## Options
237
+
238
+ | Option | Default | Behavior |
239
+ | ------------------------ | -------------------------------------- | ----------------------------------------------------------- |
240
+ | `siteId` | Required | Eloqua site ID. |
241
+ | `firstPartyCookieDomain` | Unset | First-party tracking hostname configured in Eloqua. |
242
+ | `category` | `marketing` | Consent condition for the whole loader. |
243
+ | `scriptUrl` | `https://img.en25.com/i/elqCfg.min.js` | Custom or proxied loader URL. Blank values use the default. |
244
+
245
+ Missing or blank required values log an error and never load.
246
+
247
+ Custom loaders must synchronously append one matching consent response script when `elqOptIn` or `elqOptOut` runs. Preserve `pps=41` for opt-in, `pps=42` for opt-out, and the installed account's `siteid` query parameter. The response itself can complete asynchronously. A deferred or unmatched custom response leaves consent indeterminate. The helper reports the problem and blocks tracking and further consent commands until reload.
248
+
249
+ A custom dispatcher that throws also blocks tracking and further consent commands until reload, even if it appended a matching response before throwing.
250
+
251
+ ## Loading and revocation
252
+
253
+ After consent, the helper creates `_elqQ`, sets the site ID and optional first-party cookie domain, and downloads the SDK. After loading, it queues `elqOptIn` and waits for its response script before `elqTrackPageView`. The page view uses the full current page URL, including its path, query and fragment, when the response completes.
254
+
255
+ The helper sends one consent request at a time. If consent changes while a response is pending, it waits for completion and then sends the latest choice. Withdrawal or disposal during opt-in sends `elqOptOut` after that response finishes and suppresses the page view only when the current owners no longer collectively permit tracking. Disposing one provider preserves the active lifecycle when at least one registered provider remains and every remaining provider still allows tracking. Regrant waits for any pending opt-out before opting in again. Failed responses do not trigger immediate retries or page views. A later consent update or remount can retry a failed request, including an opt-out that failed after disposal. Regrant and category changes preserve Eloqua's installed dispatcher while another provider retains its loader. If a surviving provider needs a new loader, the helper creates a fresh setup queue before loading another SDK. Each SDK execution receives its initial site and first-party settings, which the helper binds to its physical tag before loading. The helper keeps the resulting dispatcher with that tag. A detached download can still execute, so later provider adoption uses the tag's captured dispatcher.
256
+
257
+ Calling `eloquaTracking` again with equivalent options preserves the active consent lifecycle, including pending response handling across disposal and remount. Consent responses for the same site stay serialized when a provider is replaced, even if its category or loader URL changes. When providers share that configuration, every registered provider must allow the category and vendor before tracking starts. A denied provider that has never loaded still participates in this decision. SDK setup waits while a registered provider denies consent. Compatible providers can use different consent categories or loader URLs and still coordinate consent. Regranting either provider sends one page view after opt-in completes, provided every current owner allows tracking.
258
+
259
+ A provider can adopt an already-loaded compatible tag while another provider denies consent. Once the denying provider is removed or grants consent, the adopter can keep tracking after the original provider is disposed.
260
+
261
+ Use one site ID and first-party cookie domain per page. Hostname case and surrounding whitespace are normalized. An absent domain differs from a configured domain. Providers with a different site ID or domain conflict with the installed configuration. The helper reports the conflict, blocks the adopter's commands, and blocks tracking through the installed account while that provider remains registered, even if it starts denied. Withdrawal still targets the installed account and waits for its pending response. Removing the conflicting provider releases its blocker. Changing the installed site or domain requires reload, including after its script tag is removed.
262
+
263
+ If the stock SDK fails to append a consent response, the helper reports the dispatch failure without confirming the request. It sends no page view for a failed opt-in. A later explicit script reconciliation can retry that request; there is no automatic retry loop. A failed opt-out can leave Eloqua's previous opt-in cookie in place. The helper does not delete that cookie or claim withdrawal succeeded.
264
+
265
+ Keep `reloadOnConsentRevoked` enabled. Eloqua's opt-in and opt-out commands make asynchronous requests; opt-out does not disable every SDK request method or cancel requests already in flight. The helper orders its own consent requests and waits for the first-party opt-in response so a regrant page view does not run while the opt-in cookie still reads `0`. A request that never completes can hold up a later choice until reload. The loader stays in the DOM for same-page regrant because Eloqua replaces its array queue with a dispatcher. Reload gives the next page a fresh tracking lifecycle. Removing a script tag cannot unload the SDK.
266
+
267
+ Eloqua can set `ELOQUA`, `ELQSTATUS`, `ELQOPTOUT` and first-party `OPTIN` cookies. Oracle documents 13-month tracking cookie lifetimes. Reload does not erase every vendor cookie.
268
+
269
+ ## Verify Oracle Eloqua
270
+
271
+ Use a clean browser profile for the initial-state checks.
272
+
273
+ Before consent and after unrelated consent, check for no `elqCfg.min.js`, `_elqQ`, Eloqua cookies or browser storage. Grant the mapped category, which defaults to `marketing`, and allow Oracle Eloqua as a vendor. Confirm the real dispatcher replaces the array, then revoke and inspect the opt-out request. Regrant with your configured account and verify page tracking after the asynchronous opt-in completes.
274
+
275
+ Sources: [basic tracking](https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/Help/EloquaAsynchronousTrackingScripts/Tasks/BasicPageTracking.htm), [first-party tracking](https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/Help/EloquaAsynchronousTrackingScripts/Tasks/BasicPageTrackingFirst.htm), and [opt-in and opt-out commands](https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/Help/EloquaAsynchronousTrackingScripts/Tasks/OptingInAndOut.htm).
276
+
277
+ Test in a private window with an opt-in policy. Open DevTools Network, disable
278
+ the cache and filter by the vendor's domain:
279
+
280
+ 1. Load the page. No request goes to the vendor before you choose.
281
+ 2. Click Reject, then reload. There is still no vendor request.
282
+ 3. Open Privacy settings and allow the helper's category. The vendor script
283
+ loads without a page reload.
284
+ 4. Turn the category off again and save. c15t reloads the page, and the new
285
+ page makes no vendor request.
286
+
287
+ c15t reloads on revocation because removing a script element does not stop
288
+ code that already ran. The vendor's listeners, timers and queued events stay
289
+ alive until the page unloads. If you set `reloadOnConsentRevoked: false`, stop
290
+ the vendor yourself. Register a callback-only script whose `onConsentChange`
291
+ calls the vendor's opt-out API, as shown in
292
+ [custom integrations](./building-integrations.md), and check the
293
+ permission before each of your own event calls. The reload does not delete
294
+ cookies the vendor already set; see
295
+ [clear on revocation for your framework](./overview.md#vendor-switches-and-cookie-cleanup).
296
+
297
+ The helper lists its vendor by name in the preference dialog, so a visitor can
298
+ turn it off inside an allowed category. See
299
+ [vendor consent for your framework](./overview.md#vendor-switches-and-cookie-cleanup). The
300
+ [consent verification guide](../guides/verify-consent.md) covers navigation,
301
+ expiry and hosting checks.
@@ -1,8 +1,7 @@
1
1
  ---
2
2
  title: Integrations
3
- description: Find all c15t integrations for analytics, tag managers,
4
- advertising, experimentation and personalization, email and SMS, chat and
5
- embedded content.
3
+ description: Find c15t integrations for analytics, replay, monitoring,
4
+ experimentation, personalization, ads, data, chat and embeds.
6
5
  seoTitle: Cookie consent integrations for analytics and ads | c15t
7
6
  seoDescription: Connect analytics, ad pixels, chat widgets and embeds to your
8
7
  cookie banner. c15t has helpers for Google Tag Manager, Meta Pixel, PostHog,
@@ -27,121 +26,135 @@ then follow the vendor guide.
27
26
  `@c15t/integrations` is a separate package. Keep importing c15t itself from `c15t`,
28
27
  for example `c15t/react` or `c15t/next`.
29
28
 
30
- The Loading behavior column shows when each helper requests the vendor. Most
29
+ The integrations are grouped by what each tool does. The Category column names
30
+ the consent category each helper uses. The Loading behavior column shows when each helper requests the vendor. Most
31
31
  wait for the category to be allowed. A few load on every page and pass the
32
32
  permission to the vendor's own consent API, so the browser contacts the vendor
33
33
  before a choice.
34
34
 
35
- ## Embeds
36
-
37
- | Integration | v3 implementation | Loading behavior |
38
- | ------------------------------- | --------------------------------------------- | --------------------------------------------------------- |
39
- | [Google Maps](./google-maps.md) | Framework-specific consent-gated map iframe | Iframe mounts only while the chosen permission is allowed |
40
- | [YouTube](./youtube.md) | Framework-specific consent-gated video iframe | Iframe mounts only while the chosen permission is allowed |
41
-
42
- Both guides include all nine framework examples. React and Svelte use `ConsentGate`;
43
- Vue conditionally renders the iframe, and Astro and JavaScript use the existing
44
- kernel to control its DOM lifecycle. Embeds do not require `@c15t/integrations`.
45
-
46
- ## Tag managers
47
-
48
- | Integration | Helper | Category | Loading behavior |
49
- | --------------------------------------------- | ------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
50
- | [Cloudflare Zaraz](./cloudflare-zaraz.md) | `cloudflareZaraz` | `necessary` | Always runs; syncs purposes, Zaraz runs the tools |
51
- | [Google Tag Manager](./google-tag-manager.md) | `googleTagManager` | `necessary`; `measurement` or `marketing` when gated | Always loads and signals Google consent by default; `loadMode: 'after-consent'` waits for permission |
52
-
53
- ## Analytics
54
-
55
- | Integration | Helper | Category | Loading behavior |
56
- | --------------------------------------------------------- | ------------------------ | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
57
- | [Lucky Orange](./other-analytics.md#lucky-orange) | `luckyOrange` | `measurement` | Waits for effective permission |
58
- | [Google Tag](./google-tag.md) | `gtag` | `measurement` or `marketing` | Always loads and signals Google consent by default; `loadMode: 'after-consent'` waits for permission |
59
- | [Pendo](./other-analytics.md#pendo) | `pendo` | `measurement` | Waits for effective permission; stops and resumes event sending |
60
- | [Ahrefs Analytics](./ahrefs-analytics.md) | `ahrefsAnalytics` | `measurement` | Waits for effective permission |
61
- | [Adobe Analytics](./adobe-analytics.md) | `adobeAnalytics` | `measurement` | Waits for effective permission |
62
- | [Amplitude](./amplitude.md) | `amplitude` | `measurement` | Waits for effective permission; opts the SDK out on revocation |
63
- | [Cloudflare Web Analytics](./cloudflare-web-analytics.md) | `cloudflareWebAnalytics` | `measurement` | Waits for effective permission |
64
- | [RB2B](./other-analytics.md#rb2b) | `rb2b` | `marketing` | Waits for effective permission |
65
- | [Clay](./clay.md) | `clay` | `marketing` | Waits for effective permission |
66
- | [Clearbit](./clearbit.md) | `clearbit` | `marketing` | Waits for effective permission |
67
- | [Microsoft Clarity](./microsoft-clarity.md) | `clarity` | `measurement` | Gated initially; keeps the SDK and signals storage consent |
68
- | [Databuddy](./databuddy.md) | `databuddy` | `measurement` | Always loads; switches the SDK's disabled flag |
69
- | [Fathom Analytics](./fathom-analytics.md) | `fathomAnalytics` | `measurement` | Waits for effective permission |
70
- | [Heap](./heap.md) | `heap` | `measurement` | Waits for effective permission |
71
- | [Matomo Analytics](./matomo-analytics.md) | `matomoAnalytics` | `measurement` | Gated by default; optional consent mode |
72
- | [Mixpanel](./mixpanel-analytics.md) | `mixpanelAnalytics` | `measurement` | Always loads; calls opt-in and opt-out APIs |
73
- | [OneDollarStats](./one-dollar-stats.md) | `oneDollarStats` | `measurement` | Waits for effective permission |
74
- | [Hotjar](./hotjar.md) | `hotjar` | `measurement` | Waits for effective permission |
75
- | [Hightouch](./hightouch.md) | `hightouch` | `measurement` | Waits for effective permission |
76
- | [LogRocket](./logrocket.md) | `logRocket` | `measurement` | Waits for effective permission |
77
- | [Plausible Analytics](./plausible-analytics.md) | `plausibleAnalytics` | `measurement` | Waits for effective permission |
78
- | [PostHog](./posthog.md) | `posthog` | `measurement` | Configurable; defaults to always loading and calling opt-in and opt-out APIs |
79
- | [Promptwatch](./promptwatch.md) | `promptwatch` | `measurement` | Waits for effective permission |
80
- | [Pirsch](./pirsch.md) | `pirsch` | `measurement` | Waits for effective permission |
81
- | [RudderStack](./rudderstack.md) | `rudderstack` | `measurement` | Gated by default; optional destination consent mode |
82
- | [Segment](./segment.md) | `segment` | `measurement` | Waits for effective permission |
83
- | [Sentry](./sentry.md) | `sentry` | `necessary`; Replay and user data `measurement` | Configurable; defaults to always loading and loads Replay after permission |
84
- | [Rybbit Analytics](./rybbit-analytics.md) | `rybbitAnalytics` | `measurement` | Waits for effective permission |
85
- | [Statable](./other-analytics.md#statable) | `statableAnalytics` | `measurement` | Waits for effective permission |
86
- | [Umami Analytics](./umami-analytics.md) | `umamiAnalytics` | `measurement` | Waits for effective permission |
87
- | [Vercel Analytics](./vercel-analytics.md) | `vercelAnalytics` | `measurement` | Waits for effective permission |
88
- | [Vercel Speed Insights](./vercel-speed-insights.md) | `vercelSpeedInsights` | `measurement` | Waits for effective permission; drops reports after revocation |
35
+ ## Web analytics
36
+
37
+ | Integration | Helper | Category | Loading behavior |
38
+ | --------------------------------------------------------- | ------------------------ | ---------------------------- | ---------------------------------------------------------------------------------------------------- |
39
+ | [Plausible Analytics](./plausible-analytics.md) | `plausibleAnalytics` | `measurement` | Waits for effective permission |
40
+ | [Fathom Analytics](./fathom-analytics.md) | `fathomAnalytics` | `measurement` | Waits for effective permission |
41
+ | [Umami Analytics](./umami-analytics.md) | `umamiAnalytics` | `measurement` | Waits for effective permission |
42
+ | [Vercel Analytics](./vercel-analytics.md) | `vercelAnalytics` | `measurement` | Waits for effective permission |
43
+ | [Google Tag](./google-tag.md) | `gtag` | `measurement` or `marketing` | Always loads and signals Google consent by default; `loadMode: 'after-consent'` waits for permission |
44
+ | [Cloudflare Web Analytics](./cloudflare-web-analytics.md) | `cloudflareWebAnalytics` | `measurement` | Waits for effective permission |
45
+ | [Matomo Analytics](./matomo-analytics.md) | `matomoAnalytics` | `measurement` | Gated by default; optional consent mode |
46
+ | [Adobe Analytics](./adobe-analytics.md) | `adobeAnalytics` | `measurement` | Waits for effective permission |
47
+ | [Ahrefs Analytics](./ahrefs-analytics.md) | `ahrefsAnalytics` | `measurement` | Waits for effective permission |
48
+ | [Databuddy](./databuddy.md) | `databuddy` | `measurement` | Gated by default; disables the SDK on revocation |
49
+ | [Pirsch](./pirsch.md) | `pirsch` | `measurement` | Waits for effective permission |
50
+ | [Rybbit Analytics](./rybbit-analytics.md) | `rybbitAnalytics` | `measurement` | Waits for effective permission |
51
+ | [OneDollarStats](./one-dollar-stats.md) | `oneDollarStats` | `measurement` | Waits for effective permission |
52
+ | [Promptwatch](./promptwatch.md) | `promptwatch` | `measurement` | Waits for effective permission |
53
+ | [Statable](./statable-analytics.md) | `statableAnalytics` | `measurement` | Waits for effective permission |
54
+
55
+ ## Product analytics
56
+
57
+ | Integration | Helper | Category | Loading behavior |
58
+ | ----------------------------------- | ------------------- | ------------- | ---------------------------------------------------------------------------- |
59
+ | [PostHog](./posthog.md) | `posthog` | `measurement` | Configurable; defaults to always loading and calling opt-in and opt-out APIs |
60
+ | [Mixpanel](./mixpanel-analytics.md) | `mixpanelAnalytics` | `measurement` | Always loads; calls opt-in and opt-out APIs |
61
+ | [Amplitude](./amplitude.md) | `amplitude` | `measurement` | Waits for effective permission; opts the SDK out on revocation |
62
+ | [Heap](./heap.md) | `heap` | `measurement` | Waits for effective permission |
63
+ | [Gainsight PX](./gainsight-px.md) | `gainsightPx` | `measurement` | Waits for effective permission |
64
+ | [Pendo](./pendo.md) | `pendo` | `measurement` | Waits for effective permission; stops and resumes event sending |
65
+
66
+ ## Replay and monitoring
67
+
68
+ | Integration | Helper | Category | Loading behavior |
69
+ | --------------------------------------------------- | --------------------- | ----------------------------------------------- | -------------------------------------------------------------------------- |
70
+ | [Microsoft Clarity](./microsoft-clarity.md) | `clarity` | `measurement` | Gated initially; keeps the SDK and signals storage consent |
71
+ | [Hotjar](./hotjar.md) | `hotjar` | `measurement` | Waits for effective permission |
72
+ | [LogRocket](./logrocket.md) | `logRocket` | `measurement` | Waits for effective permission |
73
+ | [Sentry](./sentry.md) | `sentry` | `necessary`; Replay and user data `measurement` | Configurable; defaults to always loading and loads Replay after permission |
74
+ | [Vercel Speed Insights](./vercel-speed-insights.md) | `vercelSpeedInsights` | `measurement` | Waits for effective permission; drops reports after revocation |
75
+ | [FullStory](./fullstory.md) | `fullStory` | `measurement` | Waits for effective permission |
76
+ | [Lucky Orange](./lucky-orange.md) | `luckyOrange` | `measurement` | Waits for effective permission |
89
77
 
90
78
  ## Experimentation and personalization
91
79
 
92
- | Integration | Helper | Category | Loading behavior |
93
- | -------------------------------------------------------------------------------------- | --------------- | ------------ | ------------------------------ |
94
- | [Adobe Target](./other-experience.md#adobe-target) | `adobeTarget` | `experience` | Waits for effective permission |
95
- | [Appcues](./other-experience.md#appcues) | `appcues` | `experience` | Waits for effective permission |
96
- | [Dynamic Yield](./other-experience.md#dynamic-yield) | `dynamicYield` | `experience` | Waits for effective permission |
97
- | [Optimizely Web Experimentation](./other-experience.md#optimizely-web-experimentation) | `optimizelyWeb` | `experience` | Waits for effective permission |
98
- | [Wisepops](./other-experience.md#wisepops) | `wisepops` | `marketing` | Waits for effective permission |
99
-
100
- ## Chat and support
101
-
102
- | Integration | Helper | Category | Loading behavior |
103
- | ------------------------------------------------------------------ | --------------- | --------------- | ------------------------------ |
104
- | [Ada](./other-chat-and-support.md#ada) | `ada` | `functionality` | Waits for effective permission |
105
- | [Crisp](./crisp.md) | `crisp` | `functionality` | Waits for effective permission |
106
- | [Front Chat](./front-chat.md) | `frontChat` | `functionality` | Waits for effective permission |
107
- | [Gorgias Chat](./other-chat-and-support.md#gorgias-chat) | `gorgiasChat` | `functionality` | Waits for effective permission |
108
- | [Intercom](./intercom.md) | `intercom` | `functionality` | Waits for effective permission |
109
- | [Zendesk Messaging](./other-chat-and-support.md#zendesk-messaging) | `zendeskWidget` | `functionality` | Waits for effective permission |
110
-
111
- ## Email and SMS
112
-
113
- | Integration | Helper | Category | Loading behavior |
114
- | --------------------------------------------------------------------------------------- | ----------------- | ----------------------------- | ---------------------------------------------------------- |
115
- | [Attentive](./other-email-and-sms.md#attentive) | `attentiveTag` | `marketing` | Waits for effective permission |
116
- | [Customer.io](./other-email-and-sms.md#customerio) | `customerIo` | `marketing` | Waits for effective permission |
117
- | [Insider](./other-email-and-sms.md#insider-one) | `insiderTag` | `marketing` | Waits for effective permission |
118
- | [Klaviyo](./klaviyo.md) | `klaviyo` | `marketing` and `measurement` | Waits for both; optional forms-only mode needs `marketing` |
119
- | [Marketo Munchkin](./other-email-and-sms.md#marketo-munchkin) | `marketoMunchkin` | `marketing` | Waits for effective permission |
120
- | [Salesforce Account Engagement](./other-email-and-sms.md#salesforce-account-engagement) | `pardotTracking` | `marketing` | Waits for effective permission |
121
-
122
- ## Ads and pixels
123
-
124
- | Integration | Helper | Category | Loading behavior |
125
- | ---------------------------------------------------------- | ------------------- | ----------- | ---------------------------------------------------------------- |
126
- | [The Trade Desk](./other-ads-and-pixels.md#the-trade-desk) | `theTradeDeskPixel` | `marketing` | Waits for effective permission |
127
- | [LiveIntent](./other-ads-and-pixels.md#liveintent) | `liveIntentTag` | `marketing` | Waits for effective permission |
128
- | [AdRoll](./other-ads-and-pixels.md#adroll) | `adrollPixel` | `marketing` | Waits for effective permission |
129
- | [Vector](./other-ads-and-pixels.md#vector) | `vector` | `marketing` | Waits for effective permission |
130
- | [Meta Pixel](./meta-pixel.md) | `metaPixel` | `marketing` | Gated initially; keeps the SDK and signals consent |
131
- | [OpenAI Pixel](./openai-pixel.md) | `openaiPixel` | `marketing` | Gated initially; keeps the SDK and signals consent |
132
- | [Pinterest Tag](./pinterest-tag.md) | `pinterestTag` | `marketing` | Gated initially; keeps the tag and signals consent |
133
- | [Reddit Pixel](./reddit-pixel.md) | `redditPixel` | `marketing` | Gated initially; keeps the pixel and toggles first-party cookies |
134
- | [TikTok Pixel](./tiktok-pixel.md) | `tiktokPixel` | `marketing` | Gated initially; keeps the SDK and signals consent |
135
- | [LinkedIn Insight Tag](./linkedin-insights.md) | `linkedinInsights` | `marketing` | Waits for effective permission |
136
- | [Microsoft UET](./microsoft-uet.md) | `microsoftUet` | `marketing` | Always loads; signals ad storage consent |
137
- | [Snapchat Pixel](./snapchat-pixel.md) | `snapchatPixel` | `marketing` | Waits for effective permission |
138
- | [X Pixel](./x-pixel.md) | `xPixel` | `marketing` | Waits for effective permission |
139
-
140
- ## Commerce
141
-
142
- | Integration | Helper | Category | Loading behavior |
143
- | ----------------------- | ------------------------------ | ------------------------------------------- | ------------------------------------------------------------------ |
144
- | [Shopify](./shopify.md) | `createShopifyCustomerPrivacy` | `measurement`, `marketing`, `functionality` | Loads nothing; sends each choice to Shopify's Customer Privacy API |
80
+ | Integration | Helper | Category | Loading behavior |
81
+ | ------------------------------------------------- | --------------- | ------------ | ------------------------------ |
82
+ | [Adobe Target](./adobe-target.md) | `adobeTarget` | `experience` | Waits for effective permission |
83
+ | [Appcues](./appcues.md) | `appcues` | `experience` | Waits for effective permission |
84
+ | [Dynamic Yield](./dynamic-yield.md) | `dynamicYield` | `experience` | Waits for effective permission |
85
+ | [Optimizely Web Experimentation](./optimizely.md) | `optimizelyWeb` | `experience` | Waits for effective permission |
86
+ | [Wisepops](./wisepops.md) | `wisepops` | `marketing` | Waits for effective permission |
87
+
88
+ ## Ads and growth
89
+
90
+ | Integration | Helper | Category | Loading behavior |
91
+ | ------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
92
+ | [Meta Pixel](./meta-pixel.md) | `metaPixel` | `marketing` | Gated initially; keeps the SDK and signals consent |
93
+ | [TikTok Pixel](./tiktok-pixel.md) | `tiktokPixel` | `marketing` | Gated initially; keeps the SDK and signals consent |
94
+ | [Klaviyo](./klaviyo.md) | `klaviyo` | `marketing` and `measurement` | Waits for both; optional forms-only mode needs `marketing` |
95
+ | [Clearbit](./clearbit.md) | `clearbit` | `marketing` | Waits for effective permission |
96
+ | [LinkedIn Insight Tag](./linkedin-insights.md) | `linkedinInsights` | `marketing` | Waits for effective permission |
97
+ | [Microsoft UET](./microsoft-uet.md) | `microsoftUet` | `marketing` | Always loads; signals ad storage consent |
98
+ | [Pinterest Tag](./pinterest-tag.md) | `pinterestTag` | `marketing` | Gated initially; keeps the tag and signals consent |
99
+ | [Reddit Pixel](./reddit-pixel.md) | `redditPixel` | `marketing` | Gated initially; keeps the pixel and toggles first-party cookies |
100
+ | [Snapchat Pixel](./snapchat-pixel.md) | `snapchatPixel` | `marketing` | Waits for effective permission |
101
+ | [X Pixel](./x-pixel.md) | `xPixel` | `marketing` | Waits for effective permission |
102
+ | [OpenAI Pixel](./openai-pixel.md) | `openaiPixel` | `marketing` | Gated initially; keeps the SDK and signals consent |
103
+ | [ActiveCampaign](./activecampaign.md) | `activeCampaignTracking` | `marketing` | Waits for effective permission |
104
+ | [Attentive](./attentive.md) | `attentiveTag` | `marketing` | Waits for effective permission |
105
+ | [Customer.io](./customer-io.md) | `customerIo` | `marketing` | Waits for effective permission |
106
+ | [Insider](./insider.md) | `insiderTag` | `marketing` | Waits for effective permission |
107
+ | [Marketo Munchkin](./marketo.md) | `marketoMunchkin` | `marketing` | Waits for effective permission |
108
+ | [Salesforce Account Engagement](./salesforce-pardot.md) | `pardotTracking` | `marketing` | Waits for effective permission |
109
+ | [Oracle Eloqua](./oracle-eloqua.md) | `eloquaTracking` | `marketing` | Waits for effective permission |
110
+ | [HubSpot](./hubspot.md) | `hubspot` | `marketing` | Waits for effective permission |
111
+ | [RB2B](./rb2b.md) | `rb2b` | `marketing` | Waits for effective permission |
112
+ | [Clay](./clay.md) | `clay` | `marketing` | Waits for effective permission |
113
+ | [Default](./default-com.md) | `defaultComPixel` or `defaultComFormsSdk` | Pixel: `measurement`; SDK: `functionality`; both configurable | Pixel waits for permission by default; opt-in `loadMode: 'always'` loads before consent. Standalone SDK always waits for permission. Use one helper per document. |
114
+ | [Amazon Ads](./amazon-ads.md) | `amazonAdsTag` | `marketing` | Gated initially; keeps the tag and signals consent when ACS is enabled |
115
+ | [AdRoll](./adroll.md) | `adrollPixel` | `marketing` | Waits for effective permission |
116
+ | [LiveIntent](./liveintent.md) | `liveIntentTag` | `marketing` | Waits for effective permission |
117
+ | [The Trade Desk](./the-trade-desk.md) | `theTradeDeskPixel` | `marketing` | Waits for effective permission |
118
+ | [Vector](./vector.md) | `vector` | `marketing` | Waits for effective permission |
119
+
120
+ ## Data and tags
121
+
122
+ | Integration | Helper | Category | Loading behavior |
123
+ | --------------------------------------------- | ------------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
124
+ | [Segment](./segment.md) | `segment` | `measurement` | Waits for effective permission |
125
+ | [RudderStack](./rudderstack.md) | `rudderstack` | `measurement` | Gated by default; optional destination consent mode |
126
+ | [Hightouch](./hightouch.md) | `hightouch` | `measurement` | Waits for effective permission |
127
+ | [Google Tag Manager](./google-tag-manager.md) | `googleTagManager` | `necessary`; `measurement` or `marketing` when gated | Always loads and signals Google consent by default; `loadMode: 'after-consent'` waits for permission |
128
+ | [Cloudflare Zaraz](./cloudflare-zaraz.md) | `cloudflareZaraz` | `necessary` | Always runs; syncs purposes, Zaraz runs the tools |
129
+ | [Shopify](./shopify.md) | `createShopifyCustomerPrivacy` | `measurement`, `marketing`, `functionality` | Loads nothing; sends each choice to Shopify's Customer Privacy API |
130
+
131
+ ## Chat and embeds
132
+
133
+ | Integration | Helper | Category | Loading behavior |
134
+ | --------------------------------- | -------------------------- | ------------------ | --------------------------------------------------------- |
135
+ | [Intercom](./intercom.md) | `intercom` | `functionality` | Waits for effective permission |
136
+ | [Crisp](./crisp.md) | `crisp` | `functionality` | Waits for effective permission |
137
+ | [Front Chat](./front-chat.md) | `frontChat` | `functionality` | Waits for effective permission |
138
+ | [YouTube](./youtube.md) | None, consent-gated iframe | Chosen by your app | Iframe mounts only while the chosen permission is allowed |
139
+ | [Google Maps](./google-maps.md) | None, consent-gated iframe | Chosen by your app | Iframe mounts only while the chosen permission is allowed |
140
+ | [Ada](./ada.md) | `ada` | `functionality` | Waits for effective permission |
141
+ | [Gorgias Chat](./gorgias.md) | `gorgiasChat` | `functionality` | Waits for effective permission |
142
+ | [Zendesk Messaging](./zendesk.md) | `zendeskWidget` | `functionality` | Waits for effective permission |
143
+
144
+ The YouTube and Google Maps guides include examples for every supported framework.
145
+ Embeds do not require `@c15t/integrations`.
146
+
147
+ ## Read the integration catalog
148
+
149
+ For programmatic discovery, import `builtInScriptIntegrations` and
150
+ `BUILT_IN_INTEGRATION_KINDS` from `@c15t/integrations/registry`. Each built-in
151
+ entry has an `integrationKind`, typed as `IntegrationKind`, for the groups
152
+ above. `BUILT_IN_INTEGRATION_KINDS` supplies their labels and display order.
153
+
154
+ The existing `integrationCategory`, `IntegrationCategory` and
155
+ `BUILT_IN_INTEGRATION_CATEGORIES` keep their v3 values, so existing category
156
+ filters still work. `consentCategory` identifies the default consent category
157
+ or condition for each helper.
145
158
 
146
159
  ## Load each vendor once
147
160