Facebook Conversions API Quick Start Guide
The Facebook Conversions API allows advertisers to send events directly to Facebook via a server-side connection.
Last updated
Was this helpful?
The Facebook Conversions API allows advertisers to send events directly to Facebook via a server-side connection.
Last updated
Was this helpful?
Server-side events are sent to Facebook via the Facebook Conversions API (formerly known as Facebook Server-Side API). The Facebook Conversions API enables you to measure events that may not happen in the browser, improve accuracy by tracking events both in the browser and on the server, and more.
Accepts calls
Supports
Supports forwarding from the
Refer to this destination as Facebook Conversions API in the
If you've configured multiple Pixel IDs, you can choose a specific one by suffixing the Pixel ID, such as: Facebook Conversions API::0123456789012345. You can retrieve this value from the Facebook Conversions API configuration page for the Pixel ID of interest.
Connection Modes:
Web
Mobile
Server
Your Facebook Pixel ID and Access Token
Conversion events configured in your Freshpaint account
The installed on your site
In Facebook, go to Events Manager > Data Sources and find your Pixel ID and copy this value into your Freshpaint Facebook Conversions API destination:
To use the Facebook Conversions API, you'll need to generate an access token. Copy this value into your Freshpaint Facebook Conversions API destination:
You have successfully set up the Facebook Conversions API destination in Freshpaint!
You should see a message indicating that required properties are not allowed. Click "Configure" next to "Required Properties".
Facebook requires that you send the User Agent from the browser where the event was performed for each event. After your organization's legal/compliance team approves this, check the box next to "User Agent" and click "Confirm".
Returning to the Facebook Conversions API configuration page, click "Configure" next to "Recommended Properties".
Freshpaint recommends sending the following additional properties to facebook. After your organization's legal/compliance team approves this, check the box next to "$fbclid", and the box next to "action_source", and click "Confirm". $fbclid: When a user clicks on your ad on Facebook, the url sometimes includes a fbclid query parameter. Freshpaint captures this click ID from the url and sends the value as the Facebook Ad Click ID to help improve ad matching scores.
You've now allowed all the basic properties for Facebook Conversions API. Your destination should now look like this:
If you add the Built-in Url
to your allowlist, the url will not be redacted.
Navigate to your Freshpaint event, and toggle the destination on to enable the event to be sent to the Facebook destination.
If you've configured multiple Facebook pixels, you'll need to toggle each pixel individually for each Freshpaint event.
If you're using Google Tag Manager to send data to Facebook, and you have multiple pixel IDs enabled, you'll need to specify which pixel ID(s) you'd like to enable the event for in the event tag.
To make sure that Freshpaint is connected to your Facebook Pixel, navigate to your Events Manager.
Go to the Facebook Conversions API in Freshpaint and click "Configure".
If you are using this integration to map Freshpaint events to Facebook Standard Events, see the Reference Guide for more details.
Go to the Facebook Conversions API in Freshpaint.