@tapstack/facebook-conversion-api/README.md

Facebook Conversion API Wrapper for Node.js

Facebook Conversion API (CAPI)

> Node.js wrapper for [Facebook's Conversion API](https://developers.facebook.com/docs/marketing-api/conversions-api/) built with the Facebook Business SDK v23

## Install (requires Node.js 20+)

```bash
npm install @tapstack/facebook-conversion-api
```

## Initiate Facebook Conversion API
```node
// 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](https://developers.facebook.com/docs/marketing-api/conversions-api/get-started/#access-token) and [fbp/fbc identifiers](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc/).

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

### Add To Cart Event
```node
FBConversionAPI.addProduct('productSku', quantity);
await FBConversionAPI.sendEvent('AddToCart', sourceUrl, { value: 1000, currency: 'USD' }, { eventId: 'eventId' });
```

### Initiate Checkout Event
```node
FBConversionAPI.addProduct('productSku', quantity);
await FBConversionAPI.sendEvent('InitiateCheckout', sourceUrl, { value: 1000, currency: 'USD' }, { eventId: 'eventId' });
```

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