📘

The feature is currently in beta mode and is only available to select partners.

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 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.

The 3 steps to be followed by the partner are listed below:

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. If the issue persists, 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.

Parameters

Request

curl --location 'https://partner.gupshup.io/partner/app/bf9ee64c-3d4d-4ac4-8668-732e577007c4/subscription' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: {{partner_app_token}}' \
--data-urlencode 'modes=SENT,ENQUEUED,DELIVERED,READ,DELETED,MESSAGE, OTHERS' \
--data-urlencode 'tag=V3 Subscription' \
--data-urlencode 'showOnUI=false' \
--data-urlencode 'version=3' \
--data-urlencode 'url=https://webhook.site/0b092322-b55b-419e-9c74-eb92f2b38553'

Status Codes

Appendix

Creating Joint Solutions

Contact your Gupshup CSM and work together to determine:

• A solution name: The solution name should be agreed upon by both you and Gupshup to ensure it is distinguishable from other solutions.
• Details needed for Initiating Solution Request Gupshup recommends that Tech Providers initiate the solution request with Gupshup app ID, i.e. 2281283925530161.
• Partner Portal Setup for Tech Provider Once you have an approved solutionID, sign up as a partner on the Gupshup partner portal, providing your solution ID. If you are already registered with us on the 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.

1. Navigate to the App Dashboard > WhatsApp > Partner Solutions panel and click the Create a Partner Solution button.

2. Fill in the Solution name and Gupshup’s app ID(2281283925530161) in the partner app ID in the screen below:

3. The solution will be displayed in the solutions panel as Pending until Gupshup accepts it.
4. Upon approval, the request will be designated as Active. Confirm with your CSM that Gupshup has accepted the solution request (solution status must be Active in the Meta App Dashboard).
5. In the event of rejection, the request will be marked as Inactive. In case Gupshup rejects your solution request, please reach out to your CSM, understand the rejection reasons, and resubmit a fresh solution request, post addressing your rejection reasons.

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>"
    }
  }
}