nextjs-facebook v1.0.3

Facebook / Meta Conversion API for Next.js

Next.js wrapper for Facebook's Conversion API

This package is forked from @rivercode/facebook-conversion-api-nextjs

Facebook / Meta Conversion API for Next.js

This package helps you implement Facebook Conversion API in Next.js.

It includes an API route handler for sending server-side events to Facebook and client-side functions to trigger the events.

Facebook recommends sending events with Facebook Pixel and the Conversion API with the same event id to match duplicated events.

Therefore, we have added the option to enable standard Facebook Pixel events in this package, where we handle duplicated events out of the box.

Support Next.js API routes on both Vercel and AWS Amplify.

Install

NPM

npm install nextjs-facebook

Yarn

yarn add nextjs-facebook

1. Create Next.js API Route

App Router

app/api/route.js

import { POST } from "nextjs-facebook"

export { POST }

Pages Router

pages/api/fb-events.js

import { fbEventsHandler } from "nextjs-facebook"

export default fbEventsHandler

Add Facebook Access Token and Pixel ID

.env

FB_ACCESS_TOKEN=accessToken
NEXT_PUBLIC_FB_PIXEL_ID=pixelId
NEXT_PUBLIC_FB_DEBUG=true # optional

Read more here on how you can get your access token and pixel id.

2. Load Facebook Pixel (Optional)

This is only needed if you want to fire standard Pixel Events.

Add Facebook Pixel Provider & Script

App Router

`app/layout.js

import { FBPixelScript, FBPixelAppRouterProvider } from 'nextjs-facebook';

...
<>
  <FBPixelScript />
  <FBPixelAppRouterProvider />
</>
...

Pages Router

pages/_app.js

import { FBPixelScript, FBPixelProvider } from 'nextjs-facebook';

...
<>
  <FBPixelScript />
  <FBPixelProvider>
    <Component {...pageProps} />
  </FBPixelProvider>
</>
...

3. Start Sending Events

Trigger the events you need. For example, add to cart or purchase events.

import { fbEvent } from "nextjs-facebook"

useEffect(() => {
  fbEvent({
    eventName: "ViewContent", // ViewContent, AddToCart, InitiateCheckout, Purchase etc.
    eventId: "eventId", // optional, unique event id's will be generated by default
    emails: ["email1", "email2"], // optional
    phones: ["phone1", "phone2"], // optional
    firstName: "firstName", // optional
    lastName: "lastName", // optional
    country: "country", // optional
    city: "city", // optional
    zipCode: "zipCode", // optional
    products: [
      {
        // optional
        sku: "product123",
        quantity: 1,
      },
    ],
    value: 1000, // optional
    currency: "USD", // optional
    enableStandardPixel: false, // default false (Require Facebook Pixel to be loaded, see step 2)
  })
}, [])