Skip to content
adscapi
← Platforms
Real Conversions API

X (Twitter) setup

Set X (Twitter)’s tokens once. Then every ads.conversions.track() call fans the event out to X (Twitter) server-side — no per-platform code.

1. Install adscapi

shell
npm install adscapi
# or run without installing:
npx adscapi platforms

2. Get X (Twitter)'s tokens

X (Twitter) activates once all of these are set. Run npx adscapi platforms to see them, then get each value from X (Twitter)’s ads or events dashboard.

X_PIXEL_IDX_CAPI_TOKEN

3. Set them for adscapi

Export the tokens in the environment that runs your server or the adscapi CLI.

shell
export X_PIXEL_ID="…"
export X_CAPI_TOKEN="…"

4. Verify

check confirms the secrets are present; verify calls X (Twitter)’s API to confirm they are valid.

shell
npx adscapi check
npx adscapi verify --platform x

5. Track a conversion

One call, sent to X (Twitter) and every other configured platform. Pass raw email — adscapi hashes per platform. Consent is required.

ts
import { createAdscapi } from 'adscapi';

const ads = createAdscapi();

const results = await ads.conversions.track({
  name: 'purchase',
  value: 49,
  currency: 'USD',
  user: { email: 'buyer@example.com' },
  consent: { adUserData: true, adPersonalization: true },
});

See the exact request on the X (Twitter) payload preview.