FBE Custom Audience Onboarding

Custom Audience on Facebook Business Extension (FBE) allows businesses to optimize their ad targeting by building an audience of their customers, website visitors, mobile app visitors, or people similar to them. The FBE Custom Audience onboarding flow allows businesses to set up or integrate the following:

Business Manager
Facebook Page
Ad account

This document outlines the main prerequisites for the FBE Custom Audience flow along with a high-level overview of the steps required to complete the process. Please refer to the Facebook Business Extension guide for specific details on overall integrations.

Example — Onboarding flow from partner surface (Business Login)

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
- Private Permissions: manage_business_extension — This is a private permission that requires your Facebook representative to add your app to the allow list.
Set up authentication via Business Login (on partner platform) or Business Apps (on Facebook) with the required configurations and launch the FBE onboarding flow.

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` Type: 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` Type: string	Required. The time zone in which the business is located. See possible time zone values.
`currency` Type: string	Required. Three-letter ISO currency code of the default currency used by the business's catalog items. See supported currency codes.
`business_vertical` Type: enum	Required. Vertical associated with the business Values: `CUSTOM_AUDIENCE`
`channel` Type: enum	Required. Provides a way for the partner to configure the flow of FBE. For the Custom Audience flow, this value should be `CUSTOM_AUDIENCE`. `CUSTOM_AUDIENCE` — Flow that allows end-users to create or select Business Manager, Ad Account, and Facebook Page. Setting up with these assets enables the end-user to create a custom audience on Facebook via a third-party platform.
`business_manager_id` Type: 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` Type: 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` Type: string	Optional. Page ID for the user's existing Facebook Page that partner can enter to preselect for the user in setup flow.

Business Config

Use this object to configure the business settings for an end user. This includes CTAs, Services card, 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

Next Steps

Get Webhook notifications about businesses installing and uninstalling FBE.
Fire pixel events for every FBE-integrated business on your platform.
Add entry point to our Feature Management View from your surface.
Allow businesses to uninstall FBE.
Submit for FBE Integration Review. Once your integration is approved, your app will be available to public users.