Objective

As a Tech Provider, you can work with a Solution Provider (Such as Gupshup) to jointly create a solution that allows you and the Solution Partner to jointly manage your customer’s WhatsApp assets. With this joint solution, either the Solution Partner or the Tech Provider can host the embedded Signup on their individual portals for the customers to complete the WhatsApp Business Account (WABA) onboarding process.

This guide is intended for partners who want to host an Embedded Signup flow on their own portal after registering as Tech Provider with Meta

Prerequisites

1. Register as a Tech provider with Meta.
2. Create a joint solution with the Gupshup.
3. Register as a Tech provider with the Gupshup Bizgate Partner Portal, and create a new wallet.
4. Configure Embedded signup with the joint Solution ID generated in step 2.
5. Complete a new onboarding with the above configured embedded signup.

📘

NOTE:

Post embedded sign-up completion partners or Partner’s customer should not:

• Register the WABA using the registration API.
  • Gupshup will handle the registration process as per the onboarding flow when the partner calls the App linking API.
• Enable and set 2FA.

6. Follow the steps here to add Embedded Signup to your website. Implementation - WhatsApp Business Platform - Documentation - Meta for Developers . Meta SDK for embed signup details are also present here.
7. Once above it setup, follow steps here to enable Gupshup jointly manage customer assets and provide Gupshup Solution Partner's services. Multi-Partner Solutions - WhatsApp Business Platform - Documentation - Meta for Developers

Configure Embedded Signup
Assign the solution ID to the solutionID property in the extras.setup object within the launch method and callback registration portion of the Embedded Signup code.

// Launch method and callback registration
const launchWhatsAppSignup = () => {
  FB.login(fbLoginCallback, {
    config_id: '<CONFIGURATION_ID>', // your configuration ID goes here, ensure it is in quotes
    response_type: 'code',
    override_default_response_type: true,
    extras: {
      setup: {
        solutionID: '<SOLUTION_ID>' // add solution ID here, ensure it is in quotes
      },
      featureType: '',
      sessionInfoVersion: '3',
    }
  });
}
Both you and your partner's business portfolio (Business Settings > Business Info) will appear throughout the Embedded Signup flow.


Once configured, surface the customized Embedded SIgnup flow to customers on your platform wherever you feel it is appropriate. Note that if you have multiple active partner solutions, it is your responsibility to inject the correct solution ID into your Embedded Signup configuration and surface it to your intended customers, otherwise a customer could be onboarded using the wrong solution.

8. Complete details on Embedded Signup is mentioned by Meta over here: Embedded Signup - WhatsApp Business Platform - Documentation - Meta for Developers

After all above prerequisites are completed, use the below steps to configure the WABA and phone number to use Gupshup APIs

Step 1: Link an App

This API creates a Gupshup app, maps the WABA created with the Gupshup app, and attaches the Gupshup credit line to the WABA. The phone number passed by the partner is mapped to the WABA. Additionally, partners can also pass the optional callback URL (they wish to map with the WABA).

Partners will need to call the following APIs to link WABA ID and Phone number and get the status of Gupshup Apps.

Parameters

Request

curl --request POST --location '{{PARTNER_URL}}/partner/tpp/app' \
--header 'Authorization: <PARTNER_TOKEN>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name={{appName}}' \
--data-urlencode 'wabaId={{wabaId}}' \
--data-urlencode 'phone={{phoneNumber}}' \
--data-urlencode 'callbackUrl={{callbackUrl}}' (optional)

Response

Step 2: Get Partner App Token

This API fetches the GLOSSARY:PARTNER APP TOKEN against the GLOSSARY:PARTNER TOKEN.

Parameters

Request

curl --location '{{PARTNER_URL}}/partner/app/:appId/token' \
--header 'Authorization: <PARTNER_TOKEN>'

Response

{
  "name": "Partner_Name",
  "terms_read": true,
  "token": "{{token}}"
}

Step 3: Get Status

This API fetches the status of the Gupshup app creation and the underlying processes, as detailed in the link to app API.

Parameter

Request

curl --location '{{PARTNER_URL}}/partner/app/:appId/pipeline' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}'

Status Codes

{
    "status": "success",
    "whatsapp": {  
      "countryCode": "",
      "createdOn": 1704860430508,
      "creationStage": "WHATSAPP_PROVISIONING_DONE",
      "dialCode": "",
      "embedStage": "EMBED_STARTED",
      "id": "",
      "modifiedOn": 1707947273721,
      "pipeLineStage": "FINALIZE",
      "uiFormStage": "COMPLETE_VERIFICATION",
      "whatsappVerificationStatus": "WHATSAPP_VERIFICATION_DONE"
    }
  }

{
    "status": "success",
    "whatsapp": {  
      "countryCode": "",
      "createdOn": 1706694745887,
      "creationStage": "ERROR",
      "dialCode": "",
      "embedStage": "EMBED_PENDING",
      "id": "",
      "modifiedOn": 1707370989543,
      "pipeLineStage": "CREATE_DOCKER",
      "uiFormStage": "GET_WHATSAPP_APPROVAL",
      "whatsappVerificationStatus": "PN_DN_APPROVED"
    }
  }

{
      "status": "error",
      "message": "Please review the request parameters and retry"
    }

{
      "status": "error",
      "message": "Too Many Requests"
    }

{
      "status": "error",
      "message": "Internal server error. Please try again later and If issue still persists then contact Gupshup Dev Support"
    }

Step 4: Subscription API

📘

Note

This API should be called after the app is successfully linked with Gupshup and is marked live.

Our recommendation is to set a callback during app creation and only set subscription once the live event is received from Gupshup.

Bizgate Partner Portal Setup for Tech Provider Once you have an approved solutionID, sign up as a partner on the Gupshup Bizgate Partner Portal, providing your solution ID. If you are already registered with us on the Bizgate Partner Portal, existing ISVs can add their solution details from the settings screen.

Anything else, such as service level agreements, services provided, billing processes, etc. This decision will be made jointly by you and Gupshup based on your agreements with Meta.

Live Event

Live event payload

{
  "app": "<App Name>",
  "appId": "<App UUID>",
  "phone": "<App Phone Number>"
  "timestamp": 1636986446609,
  "version": 2,
  "type": "onboarding-event",
  "payload": {
    "type" : "docker-status-event",
    "payload" :{
       "status": "live"
       "waId" : "<Phone Number as on Whatsapp>"
    }
  }
}