Facebook CAPI through web container

This documentation is out of date ! Please refer to our latest documentation instead https://doc.commandersact.com/features/destinations/destinations-catalog/facebook/facebook-conversions-api

This connector allows you to push every kind of events directly to Facebook through API. Online conversions, add to cart... send it to Facebook and it will help you to increase the reach and accuracy of your campaigns.

You can, for example, not send campaigns related to a specific product to users who already bought it, or you can also send campaigns to users who bought a specific product in cross-sell logic.

How to send events to Facebook?

Facebook developed an API called 'Facebook Conversions API' https://developers.facebook.com/docs/marketing-api/conversions-api

You need a Facebook Business Manager account https://business.facebook.com/

Then on the menu, click on 'Events Manager':

Here, you have to create a new Web Pixel:

Select Conversions API and give a name to your connection:

Now your pixel is created and you will have access to the IDs needed on our connector (send it to our consultants).

Where can I find the Pixel ID?

Our consultants need to fill the pixel ID on our connector, it is the ID of the pixel you just created on steps above.

You can find this ID when you click on the pixel's name and on the right of the graph activities. You can find it also on the settings tab.

Please send this Pixel ID to our consultants (+ access token).

Then you need the Access Token

Where can I find the access token?

Click on the settings tab.

Scroll until the section 'Conversions API'

Click on the button 'Create Access Token':

If you are not able to click on the button 'Create access token', that mean you don't have enough rights to do it. You should be administrator on your Facebook Business account to create it.

Please send this access token to our consultants (+ pixel ID).

How to manage consents?

• Only events with a consent will be sent to Facebook

• Only conversions with personal information (email and/or phone number...) will be sent to Facebook

For customers with our product TRUST Commander:

TRUST Commander is our Consent Management Platform. (More information: https://www.commandersact.com/en/solutions/trustcommander/)

On the connector, the consent is managed with the field 'User Consent Category'. You should enter a category ID, the one corresponding to Facebook (advertising) on Trust consent categories.

For customers without our product TRUST Commander:

We should distinguish 3 cases:

• Your online events are collected through our Commanders Act event's tag: You have to provide, in the event tags, the list of category ids consented by the user, through the consent_categories property.

• You are pushing your events to us through API or CSV file: a field consent_categories must be added on the JSON or CSV to precise the consent category IDs of the user. Then inside the connector setting, use the field 'User Consent Category' to enter a category ID, the one corresponding to Facebook (advertising)

• You already manage consents on your side and you only send us, from your server,

  events that obtained the consent for the category advertising. In this case, do not fill the field ‘User Consent Category’ in the connector.

How the deduplication between the pixel and server is managed?

Using both the pixel and server is recommended per Facebook as it could avoid losing data.

To make it works, you should have the same configuration for both the pixel and server, using same Facebook parameters.

event_id should be the same

On the pixel, event_id is automatically generated by our Commanders Act Tag and we retrieve the same value for the server on_integrations.facebook.event_id_. As a result, these 2 values should be the same. Event_name should be the same also.

Fbp parameter is automatically retrieved to keep the same value between pixel and server.

Deduplication works when the same event is sent first from the browser and then from the server, otherwise it creates a duplicate. Events are pushed in real-time.

Examples

On pixel:

fbq('track', 'AddToCart', {
  value: #CARTVALUE#,
  currency: #CURRENCY#,
  contents: fb_addtocart_products,
  content_type: 'product'
}, { eventID: tC.uniqueEventId });

eventID: tc.uniqueEventId is automatically generated.

On server:

integrations.facebook.event_id

integrations.facebook.event_id automatically retrieves the eventID value coming from the pixel (eventID: tc.uniqueEventId) for standard events.

Default Mappings to Facebook Standard Events

The following mappings are fully automated and do not require any additional configuration. Any of the Commanders Act Standard Events in the table below will be sent as the corresponding Facebook Standard Event. The Facebook pixel standard events documentation has more information on these.

COMMANDERS ACT EVENTS	FACEBOOK STANDARD EVENT
begin_checkout	InitiateCheckout
purchase	Purchase
add_to_cart	AddToCart
view_item	ViewContent
view_item_list	ViewContent
search	Search
add_payment_info	AddPaymentInfo
add_to_wishlist	AddToWishlist
generate_lead	Lead
page_view	PageView
complete_registration	CompleteRegistration
contact	Contact
customize_product	CustomizeProduct
donate	Donate
find_location	FindLocation
schedule	Schedule
search	Search
start_trial	StartTrial
submit_application	SubmitApplication
subscribe	Subscribe

Facebook Custom Events

To send any of your Commanders Act events (that are not listed in the table above) to Facebook custom events, you don't have anything to do. By default, your unmapped events are automatically sent as a Facebook custom events with the name of your Commanders Act events. If you want to change the name of the custom event that will receive Facebook, you can overwrite the event_name property using integrations.facebook.event_name:'yourCustomEventName'

Default Mappings to Facebook Parameters

COMMANDERS ACT STANDARD PROPERTIES	FACEBOOK STANDARD PARAMETERS
user.id (hashed)	user_data.external_id
user.email	user_data.em (email, hashed)
user.phone	user_data.ph (phone, hashed)
user.gender	user_data.ge (gender, hashed)
user.birthdate	user_data.db (birthdate, hashed)
user.lastname	user_data.ln (last name, hashed)
user.firstname	user_data.fn (first name, hashed)
user.city	user_data.ct (city, hashed)
user.state	user_data.st (state, hashed)
user.zipcode	user_data.zp (zip code, hashed)
user.country	user_data.country (hashed)
browser.ip Automatically set if generated from Commanders Act OneTag	user_data.client_ip_address
browser.user_agent Automatically set if generated from Commanders Act OneTag	user_data.client_user_agent
integrations.facebook.fbc Automatically set if generated from Commanders Act OneTag	user_data.fbc (Click ID)
integrations.facebook.fbp Automatically set if generated from Commanders Act OneTag	user_data.fbp (Browser ID)
amount	custom_data.value
currency	custom_data.currency
items	custom_data.contents
name OR first items[i].product.name found	custom_data.content_name
category OR first items[i].product.category_N found (N ∈ [1, 5])	custom_data.content_category
default value : 'product'	custom_data.content_type
status	custom_data.status

Official documentation Customer Information Parameters

Every property can be overridden using integrations.facebook.user_data.<property> (for standard data) or integrations.facebook.custom_data.<property> (for custom data).

Minimal required information

Events can only be used if there is enough information to match a user. Facebook expects at least one user_data property, but strongly advises sending as many properties as possible.

Here are our conditions to send the events :

• at least 1 of those fields: em, ph, external_id, fbp, fbc

• at least 3 of the other fields

Note : external_id, fbp, fbc will allow matching event with other events. But to match a user, one of those events shall contain additional information (em and ph are best suited for matching)

Additional custom Facebook parameters

Custom Data Parameters - Conversions API - Documentation - Facebook for DevelopersFacebook for Developers

Custom Facebook parameters could be added.

Facebook allows you to send any data you want in custom data parameters. By default, we fill generic fields when possible (like value, currency, contents...). You can specify in the tag your own parameters in integrations.facebook.custom_data.

cact('trigger', 'purchase', {
    "currency": "EUR",
    "amount": 101,
    "integrations": {
        "facebook": {
            "custom_data": {
                "content_name": "booking",
                "your_field": "your_value"
            }
        }
    }
});