• Documentation >
• Apps >
• Marketing >
• Facebook Conversions API

Facebook Conversions API

The Facebook Conversions API module enables you to send web events from your online source directly to Facebook.

Note

If you are optimizing Facebook ads for in-store sales, please use the Facebook Offline Conversions app, instead.

Getting Started With Facebook Conversions API

Prerequisites

• A Facebook Business Manager account

• A Facebook Pixel ID

• A Facebook account

In order to use Facebook Conversions API with Ibexa Connect, it is necessary to have a Facebook account and a Facebook Business Manager account.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Facebook to Ibexa Connect

1. To connect your Facebook account to Ibexa Connect, follow the general instructions for Connecting to services.

   

2. After you click the Continue button, Ibexa Connect will redirect you to the Facebook website, where you will be prompted to grant Ibexa Connect access to your account.

   

3. Confirm the dialog by clicking the OK button.

4. Create the Facebook Pixel in your Business Manager, and retrieve your Pixel ID by following the steps below.

Actions

Send Event(s)

Sends events to your Facebook ad account's Facebook Pixel.

For better ad-targeting efficiency, please send the data as soon as you retrieve them (using webhooks or frequent scenario run scheduling). It may take up to 20 minutes for your data to be processed by Facebook.

Pixel ID	Enter your Facebook Pixel ID.
Data	(Reference: Facebook for Developers) Event ID Enter the unique event ID. Event Name Select the type of event that is sent to Facebook. For detailed event descriptions, please refer to the Facebook documentation. Event Time Enter the date and time of the event. The specified time may be earlier than the time you send the event to Facebook. This is to enable batch processing and server performance optimization. For more information, please refer to the list of supported date and time formats. Action Source Select the source where your conversions occurred. User Data Enter at least one of the user identifiers. For the detailed user data description, please refer to the User Data Parameters documentation. For a web event, the Client User Agent field is required!
Custom Data	Enter additional data you want to send to Facebook. The following properties are available: value currency content_name content_category content_ids contents content_type order_id predicted_ltv num_items search_string status
Opt Out	Select the Yes option to exclude this event from ads delivery optimization. If set to Yes, Facebook only uses the event for attribution.
Event Source URL	Enter the browser URL where the event happened.	This field is required for a web event!

Test Event Code

Enter the test event code if you want to send the test data set to Facebook. The test event code can be retrieved in Facebook Business Manager > Events Manager > Data Sources > Your Pixel* > *Test Events > Server.

Enable Limited Data Use

Select the Yes option to limit business' use of California personal information for a given event. (In accordance with the California Consumer Privacy Act - CCPA).