@tapstack/facebook-conversion-api

Facebook Conversion API (CAPI)

Node.js wrapper for Facebook's Conversion API built with the Facebook Business SDK v23

Install (requires Node.js 20+)

npm install @tapstack/facebook-conversion-api

Initiate Facebook Conversion API

// ES6 import or TypeScript
import FacebookConversionAPI from '@tapstack/facebook-conversion-api';
// CommonJS
const FacebookConversionAPI = require('@tapstack/facebook-conversion-api').default;

const FBConversionAPI = new FacebookConversionAPI(
  'accessToken',
  'pixelId',
  ['email1', 'email2'], // or null
  ['phone1', 'phone2'], // or null
  'clientIpAddress',
  'clientUserAgent',
  'fbp', // or null
  'fbc', // or null
  'debug', // default to false
);

Read more here on how you can get your access token and fbp/fbc identifiers.

ViewContent Event

FBConversionAPI.addProduct('productSku', quantity);
await FBConversionAPI.sendEvent('ViewContent', sourceUrl, { value: 1000, currency: 'USD' }, { eventId: 'eventId' });

Add To Cart Event

FBConversionAPI.addProduct('productSku', quantity);
await FBConversionAPI.sendEvent('AddToCart', sourceUrl, { value: 1000, currency: 'USD' }, { eventId: 'eventId' });

Initiate Checkout Event

FBConversionAPI.addProduct('productSku', quantity);
await FBConversionAPI.sendEvent('InitiateCheckout', sourceUrl, { value: 1000, currency: 'USD' }, { eventId: 'eventId' });

Purchase Event

FBConversionAPI.addProduct('productSku', quantity);
await FBConversionAPI.sendEvent('Purchase', sourceUrl, { value: 1000, currency: 'USD' }, { eventId: 'eventId' });