emilpriver / facebook-conversion-api

Facebook Conversion API Wrapper for Node.js.

Facebook Conversion API

Node.js wrapper for Facebook's Conversion API

Install

npm install https://github.com/RivercodeAB/facebook-conversion-api

Initiate Facebook Conversion API

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

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

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

ViewContent Event

ConversionAPI.addProduct(productSku, quantity);
ConversionAPI.sendEvent('ViewContent', sourceUrl);

Add To Cart Event

ConversionAPI.addProduct(productSku, quantity);
ConversionAPI.sendEvent('AddToCart', sourceUrl);

Initiate Checkout Event

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

Purchase Event

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