Facebook / Meta Conversion API (CAPI) for Next.js

> Next.js wrapper for Facebook's Conversion API

Facebook / Meta Conversion API for Next.js

This package helps you implement Facebook Conversion API in Next.js.
It relies on the @tapstack/facebook-dash-conversion-api package for interacting with the Facebook Graph API.
It is published under the @tapstack scope and works with Next.js 15 (including the canary releases for Partial Prerendering) and is backward compatible with Next.js 14.

Tested with Next.js 14, 15 and the latest canary.

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
``bash
npm install @tapstack/facebook-conversion-api-nextjs


also install its peer dependency for API calls


npm install @tapstack/facebook-conversion-api
`

Yarn
`bash
yarn add @tapstack/facebook-conversion-api-nextjs
`

1. Create Next.js API Route


pages/api/fb-events.js
`jsx
import { fbEventsHandler } from '@tapstack/facebook-conversion-api-nextjs/handlers';

export default fbEventsHandler;
`

$3


.env
`dotenv
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.

$3

pages/_app.js
`jsx
import { FBPixelScript, FBPixelProvider } from '@tapstack/facebook-conversion-api-nextjs/components';

...
<>





...
`

3. Start Sending Events


Trigger the events you need. For example, add to cart or purchase events.
`jsx
import { fbEvent } from '@tapstack/facebook-conversion-api-nextjs';

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)
});
}, []);
``