Skip to main content

Ads and pixels

X Pixel

Configure the X Pixel

Copy your X Pixel ID. The helper passes it to twq('config', ...). Conversion event IDs, which look like tw-xxxx-xxxx, are separate from the pixel ID.

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

export const scripts = [xPixel({ pixelId: 'YOUR_PIXEL_ID' })];

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
pixelIdRequiredPixel ID passed to twq('config', ...). The helper trims it. Empty or whitespace-only values log an error and the script does not load.
scriptSrchttps://static.ads-twitter.com/uwt.jsLoader URL override. A blank value falls back to the default.

Loading and revocation

xPixel uses the marketing category. Before marketing is allowed, c15t defines no twq function and loads nothing from X. When marketing becomes allowed, the helper queues twq('config', pixelId), then loads uwt.js.

On revocation the helper removes the script element and calls no X API. X exposes no consent update call, so the page reload is what stops the pixel. window.twq stays defined until then.

Guard your own twq calls

Conversion events come from your code, and each one needs its own check. After revocation window.twq still exists, so its presence does not mean marketing is allowed. Check the permission first, then that the pixel has loaded:

src/track-purchase.ts
export function trackPurchase(marketingAllowed: boolean, orderId: string) {
	if (!marketingAllowed || typeof window.twq !== 'function') return;
	window.twq('event', 'tw-xxxx-xxxx', {
		conversion_id: orderId,
		currency: 'USD',
		value: 99.99,
	});
}

Pass the current marketing permission from your framework, for example useConsent('marketing') in React. Set conversion_id to deduplicate the event. @c15t/integrations/x-pixel also exports xPixelEvent, a typed wrapper around twq('event', ...). xPixelEvent does nothing while twq is undefined, which is the case before marketing is first allowed. It does not check permission, so apply the same guard before calling it.

Verify the X Pixel

After you allow marketing, uwt.js loads from static.ads-twitter.com. Trigger one guarded event and check that its request to X appears. Then revoke marketing. Until the page reloads, calling trackPurchase sends nothing.

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.