Default flow

This document describes the default screens that your business customers will be presented with as they navigate the Embedded Signup flow. Note that if you inject pre-filled data, you can pre-fill some of these screens, and bypass many of them entirely, reducing the likelihood of errors and making it much easier for your business customers to onboard onto the platform.

Screens

The default implementation of Embedded Signup presents the following screens in the order depicted below.

Authentication screen This screen authenticates business customers using their Facebook or Meta Business Suite credentials.

Authorization screen This screen describes the data the business customer will be permitting your app to access.

Business portfolio screen This screen gathers information about your business customer's business. The business name field will display any business portfolios that the authenticated business customer owns, or has been granted access to. It also gives the customer the option to create a new business portfolio if they have not reached their portfolio limit. If they have reached their limit, the field will display a warning.

WABA selection screen This screen displays existing WhatsApp Business Accounts (WABA) already created on the business portfolio selected in the previous screen. It also gives business customers the option to create a new WABA on their existing portfolio, if they haven't reached their WABA limit. If they are creating a new portfolio, they are only given the option to create a new WABA. If choosing an existing WABA, the profile dropdown will display any phone profile's already created on the WABA, but also provides the option of creating a new one.

WABA creation screen This screen allows the business customer to set a name, category, and description for their public profile, which appears in the WhatsApp client when a WhatsApp user views the business phone number's profile. If the customer selects an existing profile in the previous screen, this screen will display the existing profile information. To edit an existing profile, business customers must use WhatsApp Manager.

Phone number addition screen This screen allows the business customer to enter a new business phone number to associate with their WhatsApp Business Account. It also allows the customer to choose how they wish to receive their verification code, which they will need to provide in the next step. If you are providing phone numbers to your customers, you will have to deliver these codes to your customers, or provide pre-verified numbers instead.

Phone number verification screen This screen allows the business customer to verify ownership of the business phone number they entered in the previous step.

Permissions review screen This screen provides a summary of the permissions the business customer will be granting to your app.

Success screen This screen indicates that we successfully created and associated all of the business customer's assets (business portfolio, WABA, phone number display profile, and business phone number). When the customer clicks Finish, a message event will be triggered, containing the customer's WABA ID and business phone number ID, which you must then use to onboard the customer to the platform.