Facebook Conversions Connector Setup Guide
This article describes how to set up the Facebook Conversions connector in your account.
Prerequisites
If you are using the Facebook Conversions connector for web events, the client-side Facebook Pixel tag must be running in the web browser. Learn more in the Facebook Help Center.
Enable the Tealium partner integration in your Facebook Ads account settings as follows:
- Log into your Facebook Ads Manager account and select Events Manager from the menu.
- In the menu, select Data Sources, then select the Pixel and click the Settings tab.
- Scroll down to the Server-Side API section.
- In the Partner Integration section, click Choose a Partner.
- Select Authorize Tealium Connection, and click Continue to enable Tealium.
If you do not see the option to toggle a partner integration, contact your Tealium Account Manager for support.
The Facebook Pixel tag automatically hashes user data. This pixel functionality cannot be changed.
API Information
This connector uses the following vendor API:
- API Name: Facebook Graph API - Facebook Pixel
- API Version: v16.0
- API Endpoint:
https://graph.facebook.com
Connector Actions
Action Name | AudienceStream | EventStream |
---|---|---|
Send Event | ✓ | ✓ |
Send Lead Event | ✓ | ✓ |
Configure Settings
Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.
After adding the connector, configure the following settings:
-
Dataset ID
- For your Facebook Pixel to work, ensure that you have followed the steps outlined in the Facebook Server-Side Events Connector Setup Guide to enable the partner integration for your Facebook pixel.
- For additional information, see the Facebook Pixel Setup Guide.
-
Test Connection
- If your pixel has been whitelisted and enabled for Tealium, a TealiumTestConnector event is tracked on your pixel. Click Test Connection to send a test event named TealiumConnectorTest.
- Check the Facebook Events Manager Pixel Overview to confirm the event was received.
- If your test fails, double-check the steps described in the Facebook Server-Side Events Connector Setup Guide.
Action Settings - Parameters and Options
Click Next or click the Actions tab. You configure connector actions in the Actions tab.
This section describes how to set up parameters and options for each action.
Deduplication for Facebook Pixel and Facebook Conversions API for Web Events
To configure this connector action to receive event IDs from the Facebook Pixel tag in your iQ Tag Management account, look for event attributes using the following naming convention:
fb_event_id_<Facebook Event>_<Tag UID>
For example: fb_event_id_Purchase_32
or fb_event_id_PageView
IDs were previously generated as fb_event_id_<Facebook Event>
. These IDs continue to be generated but are considered legacy. The new IDs allow for use with multiple Facebook tags firing on a single page and offer a stronger tie back to the related tag. If you are using the legacy version, you must change the connector to the new ID.
Use a separate action for each type of event ID. Map the event-specific event ID attribute to Event ID with the matching event name mapped to Event Name. For example:
Tealium Attribute/Value | Facebook Parameter |
---|---|
fb_event_id_Purchase |
Event ID |
“Purchase” (Custom Text) | Event Name |
See the Facebook Pixel Tag Setup Guide.
Automatic Deduplication
When the Automatic Deduplication value is populated, the connector will look for the corresponding variable within the UDO object. You are no longer required to add an Event ID if this section is populated and you are using Tealium iQ. However, the following approach may still be needed when using EventStream without TealiumiQ.
The connector uses the following order of operations:
- If Automatic Deduplication is populated, and the value is found in the data layer, (for example,
fb_event_id_ViewContent_30
) this value supersedes anything mapped in Event ID. - If Automatic Deduplication is populated, but it can’t find the tag ID version, but can find the legacy version (with no ID attached), that value is used (for example,
fb_event_id_ViewContent
). - If Automatic Deduplication is populated, but the valie isn’t found, the mapped Event ID is used, if it is populated.
Offline conversions
Tealium recommends using the Facebook Conversions connector for offline conversions instead of the Facebook Offline Conversions connector for new integrations.
To process offline and store events through the Facebook Conversions connector, set the action_source
parameter to physical_store
.
Action - Send Event
Parameters
For User Data parameters, the following table notes the level of importance for some parameters. The importance level describes the parameter’s influence on your event match quality. For example, Email (em) has an importance level of Highest while Phone Number (ph) has an importance level of High.
Parameter | Description |
---|---|
Event Source URL |
|
Test Event Code |
|
Data Processing Options |
|
Event Name |
|
Debugging Level |
|
Action Source |
|
Dataset ID Override |
|
Data Processing Options Country |
|
Event ID |
|
Event Time |
|
Data Processing Options State |
|
Opt Out |
|
Zip (zip) |
|
FB Login ID |
|
Partner ID |
|
Partner Name |
|
Client User Agent (ua) |
|
Client IP Address (ip) |
|
Phone (ph) |
|
State (st) |
|
Email (em) |
|
Last Name (ln) |
|
First Name (fn) |
|
Lead ID |
|
City (ct) |
|
Country (country) |
|
External ID |
|
Browser ID (fpb) |
|
Subscription ID |
|
Gender |
|
Date of Birth |
|
Click ID (fbc) |
|
User Data is already hashed |
|
Currency |
|
Content Name |
|
Number of Items |
|
Search String |
|
Order ID |
|
Content Type |
|
Predicted Lifetime Value |
|
Content IDs |
|
Value |
|
Content Category |
|
Quantities |
|
Prices |
|
IDs |
|
JSON Template Variables |
|
JSON Templates |
|
Tealium iQ Tag ID | The Facebook Pixel Tag ID. |
Disable Automapping | Disable automapping of parameters. |
Automatic Deduplication |
|
Advertiser Tracking Enabled | Required. Use this field to specify ATT permission on an iOS 14.5+ device. Set to 0 for disabled or 1 for enabled. |
Application Tracking Enabled | Required. You can enable ad tracking at the app level. Your SDK should allow an app developer to put an opt-out setting into their app. Use this field to specify the person’s choice. Use 0 for disabled, 1 for enabled. |
App Version | Required. The Version must be a2 for Android or i2 for iOS. |
OS Version | Required. OS version, for example: 13.4.1 . |
App Package Name | The app package name, for example: com.facebook.sdk.samples.hellofacebook . |
Short Version | The short version, for example: 1.0 . |
Long Version | The long version, for example: 1.0 long . |
Device Model Name | The device model name, for example: iPhone5,1 . |
Locale | The locale, for example: En_US . |
Timezone Abbreviation | The timezone abbreviation, for example: PDT . |
Carrier | The carrier, for example: AT&T . |
Screen Width | The screen width, for example: 320 . |
Screen Height | The screen height, for example: 568 . |
Screen Density | The screen density, for example: 2 . |
CPU Cores | The CPU cores, for example: 2 . |
Storage Size (GB) | The external storage size in GB, for example: 13 . |
Free Storage (GB) | The free space on external storage in GB, for example: 8 . |
Device Timezone | The device timezone, for example: USA/New York . |
Campaign IDs | An encrypted string and non-user metadata appended to the outbound URL (for example, ad_destination_url ) or deep link (for App Aggregated Event Manager) when a user clicks a link from Facebook. |
Install Referrer | Third party install referrer, currently available for Android only. For more information, see Campaign Measurement. |
Installer Package | Used internally by the Android SDKs. |
Url Schemes (Array) | Used internally by the iOS and Android SDKs. |
Windows Attribution ID | Attribution token used for Windows 10. |
Anon ID | Your install ID. This field represents unique application installation instances. |
MADID | Your mobile advertiser ID, which is usually the advertising ID from an Android device or the Advertising Identifier (IDFA) from an Apple device. |
Action - Send Lead Event
Batch Limits
This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met:
- Max number of requests: 1000
- Max time since oldest request: 10 minutes
- Max size of requests: 1 MB
Parameters
Parameter | Description |
---|---|
Lead ID | (Required) The Facebook-generated 15 or 16 digit leadgen_id from your downloaded leads. This number is obtained from the leadgen_id field in the lead generation webhook and included in the user_data parameter. |
Event Name | (Required) Capture the lead stages you use in your CRM. The event_name parameter should indicate a lead moving through the sales funnel in your CRM. Make sure to send all stages as they are updated, including the raw lead. |
Event Time | A Unix timestamp in seconds indicating when the lead stage update event is updated by your CRM. The timestamp must occur after the lead generation time or the event may be discarded. If this field is not mapped, it will be initialized with the current timestamp. |
Test Event Code | You can verify that your server events are received correctly by Facebook by using the Test Events feature in Events Manager. To find the tool, navigate to Events Manager > Data Sources > Your Pixel > Test Events. |
Setup
There are several options available to setup and manage Tealium’s server-side API partner integration with Facebook.
- The Facebook Partner Integration Gallery
- The Pixel Settings tab via the Choose Partner button:
- The web signal setup flow and Server-side API guidance card:
Verify Events
After sending your events, verify that Facebook has received them in the overview and breakdown views:
- Go to Business Manager > Pixels.
- Click on the pixel corresponding to the
PIXEL_ID
in yourPOST
request.

Overview Tab
In the Overview tab, change the view from All to Server to see the number of events you have successfully sent.

Breakdown Tab
The Breakdown tab displays the breakdown of successfully sent events. Dropped events do not appear in the Server Events Received
column.

You can verify events within 20 minutes after sending them from your server.
Validation
For validation, use Facebook’s Payload Helper with your data parameter fields to see how structure your payload when it’s sent to Facebook from your server. See Facebook’s Support page for troubleshooting issues.
Learn more at Facebook’s Using the Conversions API.
This page was last updated: August 11, 2022