MBE Pixel and Conversions API Onboarding

The Pixel and Conversions API flow for Meta Business Extension (FBE) allows users to create or select their Business Manager, Page, and Meta Pixel. This flow is recommended for partners with website hosting capabilities. Using the pixel returned after completing this flow, partners can send events to Facebook on behalf of their clients via browser or the Conversions API. This flow does not have Catalog capabilities.

Before You Start

Your app must be owned by a Business Manager that is a verified business. Learn more about how to verify your business.
A Facebook app is required with the following access level, feature and permissions:
- Access Level: Advanced Access
- Feature: Ads Management Standard Access
- Public Permissions: ads_management, pages_read_engagement, and ads_read
- Private Permissions: manage_business_extension — This is a private permission that requires your Facebook representative to add your app to the allow list.
- System User Access Token: Sending events to the Conversions API requires an Access Token. To generate an Access Token on behalf the client, use the Access Token returned via FBE and convert it into a System User Access Token by making an additional API call.

Required Configurations

Extras

Field Description

Field	Description
`setup` Type: setup	Required. Seller’s Facebook setup, such as their unique identifier (`external_business_id`) or the currency of their catalog (`currency`). See setup object details.
`business_config` Type: business_config	Required. Configuration object that the Meta Business Extension uses to configure the Meta Business Extension workflow. See `business_config` object details.
`repeat` Type: boolean	Required. Set this value to `false`.

setup

Type: setup

Required.

Seller’s Facebook setup, such as their unique identifier (external_business_id) or the currency of their catalog (currency). See setup object details.

business_config

Type: business_config

Required.

Configuration object that the Meta Business Extension uses to configure the Meta Business Extension workflow. See business_config object details.

repeat

Type: boolean

Required.

Set this value to false.

Setup

Use this object to define the settings for the end user's Facebook presence

Field	Description
`external_business_id` string	Required Unique business ID to represent your client's business. We use this as a unique identifier. For example, if the seller's company is called "Fubar", then "fubar-123" could be their `external_business_id`.
`timezone` string	Optional The time zone in which the business is located. See possible time zone values.
`currency` string	Optional Three-letter ISO currency code of the default currency used by the business's catalog items. See supported currency codes.
`business_vertical` enum	Required Vertical associated with the business Value: `ECOMMERCE`
`merchant_settings_id` string	Optional Used when upgrading from Facebook Business Extension, v1. Contact your Facebook representative if you are migrating from v1 to v2.
`domain` string	Required for COMMERCE and COMMERCE_OFFSITE channels Domain used for Instagram manual approval. For example: `https://exampleshop.partnersite.com`.
`channel` enum	Required Provides a way for the partner to configure the Conversions API flow of FBE. For the Conversions API flow, this value should be `CONVERSIONS_API`. `CONVERSIONS_API` — Flow that allows end-users to create or select Business Manager, Ad Account, and Meta Pixel objects. Creating these objects enables the end-user to send events from their website to Facebook via Conversions API or browser Pixel.
`business_manager_id` string	Optional Business Manager ID for user's existing Business Manager that a partner can enter to preselect for the user in the setup flow.
`ad_account_id` string	Optional Ad Account ID for user's existing ad account that a partner can enter to preselect for the user in the setup flow.
`page_id` string	Optional Page ID for the user's existing Facebook Page that partner can enter to preselect for the user in setup flow.
`ig_profile_id` string	Optional Instagram Business Profile ID for the user's existing Instagram Business Profile that a partner can enter to preselect for the user in the setup flow.
`pixel_id` string	Optional Pixel ID for the user's existing Pixel that a partner can enter to preselect for the user in the setup flow.
`catalog_id` string	Optional Catalog ID for the user's existing catalog that a partner can enter to preselect for the user in the setup flow.

Business Config

Use this object to configure the business settings for an end user. This includes CTAs and more. Each field includes a "type" linked to the respective tables below.

Field	Description
`business` Type: FBEBusinessPropertiesConfigData	Required Information for the end user's business
`messenger_chat` Type: FBEMessengerChatConfigData	Optional Messenger chat features on the end user's Facebook page, such as `enabled` and `domains`.
`catalog_feed_scheduled` Type: FBECatalogFeedConfigData	Optional Determines whether the Facebook Business Extension should use a feed approach, which grabs catalog items from a `feed_url`.
`page_cta` Type: FBEPageCtaConfigData	Optional Call to action (CTA) button on end user's page, such as `cta_button_text`, `cta_button_url`, and so on.
`ig_cta` Type: FBEIGCtaConfigData	Optional Features for the Instagram call to action (CTA) feature, such as `enabled`, `cta_button_text`, `cta_button_url`, and so on.
`messenger_menu` Type: FBEMessengerMenuConfigData	Optional Features for the Messenger persistent menu feature, such as `cta_button-text` and `cta_button_url`