FBE Messaging Onboarding

The Facebook Business Extension (FBE) allows businesses to easily set up and manage conversations with their customers at scale on Facebook and Instagram. The FBE Messaging onboarding flow allows businesses to set up or integrate the following:

  • Business Manager
  • Facebook Page
  • Instagram account (if already connected with Facebook Page)
  • Ad account
  • Messenger chat (optional)

This document outlines the main prerequisites for the FBE Messaging 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 Facebook surface (Business Apps)

Before You Start

  1. Your app must be owned by a Business Manager that is a verified business. Learn more about how to verify your business.
  2. A Facebook app is required with the following access level, feature and permissions:

  3. Set up authentication with the required configurations and launch the FBE onboarding flow via Business Login (on partner platform) or Business Apps (on Facebook).

Required Configurations

Extras

FieldDescription

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

FieldDescription

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: MESSAGING

channel
Type: enum

Required.
Provides a way for the partner to configure the flow of FBE. For the Messaging flow, this value should be MESSAGING.

  • MESSAGING — Flow that allows end users to create or select Business Manager, Ad Account, Facebook Page, and Instagram account. Setting up with these assets enables the end user to manage conversations with their customers at scale.

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.

ig_profile_id
Type: 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.

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.

FieldDescription

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

messenger_menu
Type: FBEMessengerMenuConfigData

Optional.
Features for the Messenger persistent menu feature, such as cta_button-text and cta_button_url

Next Steps