search
No-code docs

Setting up the WhatsApp Embedded flow

To onboard your customers onto WhatsApp, you will need to integrate the WhatsApp embedded flow into your own platform. This enables your customers to share permissions for you and Bird to manage their WhatsApp business account and send messages on their behalf. Customers share permissions by logging in through the embedded signup flow.

hashtag
Setting up the embedded flow

See the following guidearrow-up-right from Meta on how to complete this. When embedding the signup flow, there are two important extra data fields (as shown in the extras.setup object below) that must be set correctly:

  1. Solution_Id: This should be set to the solutionId obtained after you connected to Bird as a solutions providerarrow-up-right. This ensures that your end customer is onboarded for both your business and allows Bird to send messages on behalf of this customer

  2. Preverified_Id: If you’ve obtained a number from Bird for your customer, it will already be pre-verified (authenticated) for WhatsApp. Including the preverified_id when launching the signup flow enables the customer to onboard without needing to receive an OTP code for the number. See the instructions below on how to obtain the pre-verified Id.

<script type="text/javascript">
  document.getElementById('login-btn').onclick = () =>
    FB.login(response => {}, {
      config_id: '{{config_id}}', 
      response_type: 'code',    
      override_default_response_type: true, 
      extras: {
        setup: {
          solutionID: {{solution_id}}
          preVerifiedPhone: {
            ids: ['{{preverified Id}}']
          },...
        }
      }
    });
</script>

You should also implement session loggingarrow-up-right to get the phone_number_id and waba_id after the user completes the embedded signup.

hashtag
Apply for advanced access to Meta public_profile

For the embedded signup to work, you must apply for advanced access to the public_profile permission on your Meta app. In the Meta for developers app dashboard, navigate to your App Review > Permissions and features are ensure you have advanced access as shown

hashtag
Getting pre-verified number ID (optional)

If you have purchased a number for your customer through Bird CRM, this should be automatically pre-verified for use on WhatsApp. This typically takes around 5 minutes from completing the number purchase. To list the numbers in your workspace you can list them as follows

hashtag
Get Number

get

Retrieve a specific number details by its ID. This number is part of the workspace purchased number inventory.

Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstring · uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e
numberIdstringRequired

The number/endpoint ID.

Example: e40ce70f-e7e0-45c0-9d64-2fc7d0401a16
Responses
chevron-right
200

OK

application/json
typestring · enumOptional

The type of the number.

Possible values:
numberstring · min: 1 · max: 30Optional

The phone number in E.164 format.

Example: +14155552671
countrystring · iso3166-1Optional
idstring · uuidRequired

The ID of the number.

statusstring · enumRequired

The status of the number.

Possible values:
createdAtstring · date-timeRequired

Timestamp (UTC) when the number was created.

updatedAtstring · date-time · nullableRequired

Timestamp (UTC) when the number was last updated.

activatedAtstring · date-time · nullableOptional

Timestamp (UTC) of the last time the number was activated.

deactivatedAtstring · date-time · nullableOptional

Timestamp (UTC) of the last time the number was deactivated.

deactivatesAtstring · date-time · nullableOptional

Timestamp (UTC) when the number will be deactivated.

get
/workspaces/{workspaceId}/numbers/{numberId}

To get the pre-verified number ID check the number.whatsApp object as follows. You should make use of the whatsAppId.In addition before starting the embedded flow ensure that:

  1. status: verified

  2. stage: final

  3. verificationExpiresAt is after now

hashtag
Embedded signup completion

Once your customer has completed the embedded signup, you should collect the phone_number_id and waba_id from the sessionInfoarrow-up-right object

In addition you should get an authResponsearrow-up-right object which will contain a token which will be exchanged for a long lived access token

hashtag
Exchange debug token for long lived token

Once the embedded signup has been completed and you have the phone_number_id, waba_id, and code you should submit this to an api endpoint e.g. <somedomain>/installwhatsapp. In addition if you are using a number bought via Bird then you should also include the unique id of the number

From this API you can then exchange the codearrow-up-right you have a long lived access token. You should use the Meta App_ID and App_Secret from the app you created earlier.

You should securely associate the long lived token and WABA ID with the customer account in your platform.

Install WhatsApp phone number in Bird CRMchevron-right

Last updated

Was this helpful?