MBE Appointments Onboarding

The Meta Business Extension (MBE) Appointments flow enables sellers on your platform to access a broad suite of business tools, such as Book Now call-to-action buttons, on their Facebook Page, Instagram account and Messenger chats with customers.

Example — Onboarding flow from partner surface (Business Login)

Before You Start

1. Register as a Meta developer to access our developer tools and create Facebook apps.
2. If you haven’t yet, create a Meta app, selecting Business app type.
3. Create a test app from your live/production app and use it to perform all new development and testing.
4. Your apps (live/production and test) must be Business app type and owned by a Business Manager that is a verified business. Learn more about how to verify your business and how to add your apps to it.
5. Add the MBE Developer Panel to your App.
6. If you want to enable the Featured Services page card feature, your app will need to get approved Catalog permission (catalog_management) via App Review before going live. catalog_management allows your app to create, read, update and delete business-owned catalogs (Services inventory). Submit the App Review request as soon as you have a working demo you can use to screencast how:
   • Catalog permission is requested on the onboarding flow
   • The Services inventory is pushed to the connected Catalog
   • The Services card is enabled on the connected Page at the end

Onboarding Steps and Entry Points

Business owners (clients) need a mechanism to connect their business on a partner platform to their Facebook or Instagram profiles, and vice versa. The onboarding flow can be used to accomplish this. The Appointments flow includes:

• Asset creation/selection
  • Business Manager
  • Ad account
  • Catalog (optional)
  • Instagram Profile
  • Facebook Page
  • Meta Pixel
• Granting permissions
  • Manage business extension
  • Manage catalogs (optional)
• Business setup and features

To enable the connection, you need to support two authentication flows, depending on where the user (business owner) starts the connection:

• Partner Surface (commonly known as Business Login) — Allows businesses to initiate the connection from your platform, using a button you place on your site.
• Business Apps — Allows businesses to initiate the connection from Facebook/Instagram. To enable this flow and have your app listed on Business Apps, you must provide a custom authentication UI that allows the user to select their business on your site and then redirect them back to the Facebook or Instagram flow.

Required Configurations

extras

setup

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

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.

Example Appointments extras

{
    "setup": {
        "external_business_id": "<YOUR_ID_FOR_THE_BUSINESS>",
        "timezone": "<BUSINESS_TIMEZONE>",
        "currency": "<BUSINESS_CURRENCY>",
        "business_vertical": "APPOINTMENTS"
    },
    "business_config": {
        "business": {
            "name": "<BUSINESS_NAME>"
        },
        "page_cta": {
            "enabled": true,
            "cta_button_text": "Book Now",
            "cta_button_url": "<BUSINESS_URL_FOR_CTA>",
            "below_button_text": "Powered by <YOU>"
        },
        "page_card": {
            "enabled": true,
            "see_all_text": "See All",
            "see_all_url": "<BUSINESS_URL_FOR_CTA>",
            "cta_button_text": "Book"
        },
        "ig_cta": {
            "enabled": true,
            "cta_button_text": "Book Now",
            "cta_button_url": "<BUSINESS_URL_FOR_CTA>"
        },
        "messenger_menu": {
            "enabled": true,
            "cta_button_text": "Book Now",
            "cta_button_url": "<BUSINESS_URL_FOR_CTA>"
        },
        "thread_intent": {
            "enabled": true,
            "cta_button_url": "<BUSINESS_URL_FOR_CTA>"
        }
    },
    "repeat": false
}

Learn more about Business Configurations.

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.
• Send us a business's full inventory and keep the Catalog updated (optional).
• Allow businesses to uninstall the FBE.
• Submit for FBE Integration Review. Once your integration is approved, you will be able to launch your application to public users.