--- title: X Pixel (Twitter Pixel) description: Track conversions and build audiences for advertising campaigns on X (formerly Twitter). lastModified: 2025-09-24 icon: x --- X Pixel (formerly Twitter Pixel) is X's conversion tracking and audience building tool. It helps you measure ad performance, retarget website visitors, and optimize campaigns on the X platform. By default, c15t loads this script based on `marketing` consent. ## Implementation > ℹ️ **Info:** > See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js). ```ts import { xPixel } from '@c15t/scripts/x-pixel'; xPixel({ id: '123456789012345', }) ``` ## xPixelEvent You can use the `xPixelEvent` function to track events. This is a wrapper around the `twq` function that the X Pixel script uses. ```ts import { xPixelEvent } from '@c15t/scripts/x-pixel'; xPixelEvent('tw-xxxx-xxxx', { value: 10.00, currency: 'USD' }); ``` ## Types ### XPixelOptions |Property|Type|Description|Default|Required| |:--|:--|:--|:--|:--:| |pixelId|string|Your X Pixel ID|-|✅ Required| |scriptSrc|string \|undefined|X Pixel loader URL.|-|Optional| ### Script |Property|Type|Description|Default|Required| |:--|:--|:--|:--|:--:| |id|string|Unique identifier for the script|-|✅ Required| |src|string \|undefined|URL of the script to load|-|Optional| |textContent|string \|undefined|Inline JavaScript code to execute|-|Optional| |category|HasCondition\|Consent category or condition required to load this script|-|✅ Required| |callbackOnly|boolean \|undefined|Whether this is a callback-only script that doesn't need to load an external resource. When true, no script tag will be added to the DOM, only callbacks will be executed.|false|Optional| |persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional| |alwaysLoad|boolean \|undefined|Whether the script should always load regardless of consent state. This is useful for scripts like Google Tag Manager or PostHog that manage their own consent state internally. The script will load immediately and never be unloaded based on consent changes. Note: When using this option, you are responsible for ensuring the script itself respects user consent preferences through its own consent management.|false|Optional| |fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional| |attributes|Record\ \|undefined|Additional attributes to add to the script element|-|Optional| |async|boolean \|undefined|Whether to use async loading|-|Optional| |defer|boolean \|undefined|Whether to defer script loading|-|Optional| |nonce|string \|undefined|Content Security Policy nonce|-|Optional| |anonymizeId|boolean \|undefined|Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockers|true|Optional| |target|"head" \|"body" \|undefined|Where to inject the script element in the DOM. Options: \`'head'\`: Scripts are appended to \`\\` (default); \`'body'\`: Scripts are appended to \`\\`|'head'|Optional| |onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional| |onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional| |onError|Object \|undefined|Callback executed if the script fails to load|-|Optional| |onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional| |vendorId|string \|number \|undefined|IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over \`category\` when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.|-|Optional| |iabPurposes|number\[] \|undefined|IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.|-|Optional| |iabLegIntPurposes|number\[] \|undefined|IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.|-|Optional| |iabSpecialFeatures|number\[] \|undefined|IAB TCF special feature IDs this script requires. Options: 1: Use precise geolocation data; 2: Actively scan device characteristics for identification|-|Optional| #### `onBeforeLoad` Callback executed before the script is loaded |Property|Type|Description|Default|Required| |:--|:--|:--|:--|:--:| |id|string|The original script ID|-|✅ Required| |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required| |hasConsent|boolean|Has consent|-|✅ Required| |consents|ConsentState|The current consent state|-|✅ Required| |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional| |error|Error \|undefined|Error information (for error callbacks)|-|Optional| #### `onLoad` Callback executed when the script loads successfully |Property|Type|Description|Default|Required| |:--|:--|:--|:--|:--:| |id|string|The original script ID|-|✅ Required| |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required| |hasConsent|boolean|Has consent|-|✅ Required| |consents|ConsentState|The current consent state|-|✅ Required| |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional| |error|Error \|undefined|Error information (for error callbacks)|-|Optional| #### `onError` Callback executed if the script fails to load |Property|Type|Description|Default|Required| |:--|:--|:--|:--|:--:| |id|string|The original script ID|-|✅ Required| |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required| |hasConsent|boolean|Has consent|-|✅ Required| |consents|ConsentState|The current consent state|-|✅ Required| |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional| |error|Error \|undefined|Error information (for error callbacks)|-|Optional| #### `onConsentChange` Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded. |Property|Type|Description|Default|Required| |:--|:--|:--|:--|:--:| |id|string|The original script ID|-|✅ Required| |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required| |hasConsent|boolean|Has consent|-|✅ Required| |consents|ConsentState|The current consent state|-|✅ Required| |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional| |error|Error \|undefined|Error information (for error callbacks)|-|Optional| ### XPixelEvent |Property|Type|Description|Default|Required| |:--|:--|:--|:--|:--:| |value|number \|undefined|Total value of the conversion event (ex: $ value of the transaction in case of a purchase, etc.)|-|Optional| |currency|string \|undefined|Currency of the conversion event ISO 4217 code (ex: USD, EUR, JPY, etc.)|-|Optional| |conversion\_id|string \|undefined|Unique identifier for the event that can be used for deduplication purposes|-|Optional| |search\_string|string \|undefined|Search string of the conversion event|-|Optional| |description|string \|undefined|Description of the conversion event|-|Optional| |twclid|string \|undefined|twclid of the conversion event The X Pixel already automatically passes twclid from URL or first-party cookie. This parameter can be optionally used to force attribution to a certain ad click.|-|Optional| |status|boolean \|undefined|Status of the conversion event|-|Optional| |contents|XPixelContent \|undefined|Content/products associated with the conversion event|-|Optional| ### XPixelContent |Property|Type|Description|Default|Required| |:--|:--|:--|:--|:--:| |content\_type|[string \|undefined](https://www.google.com/basepages/producttype/taxonomy.en-US.txt)|Type of the content|-|Optional| |content\_id|string|ID of the content For product catalog users: please pass SKU For all other users: Please pass Global Trade Item Number (GTIN) if available, otherwise pass SKU|-|✅ Required| |content\_name|string \|undefined|Name of a product or service|-|Optional| |content\_price|number \|undefined|Price of a product or service|-|Optional| |num\_items|number \|undefined|Quantity of the content|-|Optional| |content\_group\_id|string \|undefined|ID associated with a group of product variants|-|Optional|