The Facebook Business Extension, v1 is currently only available to whitelisted Partners. Please contact your Facebook representative for access.

To use the Facebook Business Extension (FBE) framework, you need to build a plugin for a platform. This guide assumes that you're familiar with the platform for the plugin you're building.

This plugin should open a pop-up to Facebook, as shown in the image above. This pop-up contains the Facebook Onboarding Flow, which allows the user to select and create the necessary Facebook objects to upload all of their products to Facebook and install the Facebook pixel on their site. The image below illustrates the overall architecture.

The Facebook Business Extension architecture has 2 main components:

  • A Native Platform Integration, or plugin, that you build
  • The Facebook Onboarding Flow pop-up, already built by Facebook, that your plugin opens

To integrate with FBE, you must integrate with the Facebook Onboarding Flow pop-up. Thus, your native plugin should provide 4 features; see Implementation Requirements for more details:

For example, when a user finishes the Facebook Onboarding Flow inside the pop-up, the pop-up sends a "Set Pixel” message that contains a pixel ID to your plugin. Your plugin should then take this ID and add pixel code with this ID to every page. Detailed explanation and examples of how to do this are provided in subsequent sections.