Coex - Onboarding Business App users

Co-existence allows you to connect your existing WhatsApp Business App number to Gupshup.

  • WhatsApp business App users can connect to Cloud API and take advantage of the automations
  • You can still use the WhatsApp Business App as usual
  • Chat history remains synced between both

Know Limitations from Meta

No Payment attached to the WhatsApp Business App

  • Please ensure that no payment method (card or any other local payment option) is linked to your WhatsApp Business App.
    • This will not allow Gupshup to attach our credit line.
    • Recommedation here is that you remove all the payment method before proceeding.

Known Meta Issues

  1. Phone number not eligible for Co-existence

    • Meta has not yet shared the eligibility criteria for phone numbers
    • No workaround or resolution has been provided so far
  2. “Error Object” while submitting phone number

    • Occurs during the onboarding flow
    • Meta has not shared updates or a fix yet
  3. Multiple or inconsistent onboarding errors

    • Errors may appear at different steps of the flow
    • Currently under Meta investigation, with no confirmed timeline
  4. Inconsitent Events

    The blow-mentioned webhooks/features are currently experiencing issues from Meta’s end.

    1. History events
    2. Contact sync
    3. Smb_message_echoes
🚧

For all the above-mentioned issues, we will update the documentation or share additional information once we receive further clarification from Meta.

ℹ️

Note: All apps will receive DRL events as they used to.

Before You Start (Quick Checklist)

Please make sure:

  • Your WhatsApp Business App version is 2.24.17 or higher
  • Your phone number country is supported
  • Facebook login with Business Manager access
  • Ability to scan a QR code from your WhatsApp Business App
  • Your Whatsapp account in business App should be 3 months old with active messaging

Countries currently not supported

Nigeria and South Africa

Enablement

There is no enablement required. You can continue creating apps through Self Serve UI (gupshup.io)

Onboarding Steps

  1. Create a new App or choose any non-live app that you have and click the Begin Go Live button to start the Go Live flow:

  2. You will see an option to use an existing WhatsApp Business App number, select use existing WhatsApp Business

  3. Select your local storage region if required; otherwise, let it be DEFAULT and click Next

  4. Enter the contact details, select the terms and conditions, and click Next.

  5. Confirm Contact details

  6. Click on Continue with Facebook or use embed signed link to process

  7. Click Continue, select Business portfolio then Connect a WhatsApp Business app from the WhatsApp Business account tab, and click Next.

  8. Enter a WhatsApp Business app phone number and click Next

  9. Businesses that select this option and enter their WhatsApp Business app phone number will see a QR code and instructions to check for new WhatsApp Business app messages:

  10. The WhatsApp message instructs the business to use the app to scan the QR code displayed in Embedded Signup:

  11. Connect to the Business Platform and complete the process
    Note: You can either use QR code scan or use access code

  12. Please ensure that all chats are shared if you want to receive history events. If chats are not connected here, Meta will not share the history events.

    Also, if you skip this step now and decide to enable it later, you will need to deregister your WABA from the Cloud API and complete the onboarding process again.

    Please refer to the Sync API section to learn more about triggering history events. Please ensure that all chats are shared if you want to receive history events. If chats are not connected here, Meta will not share the history events.

  13. After all the above Successful process, on the FB page select the time zone and complete the shown process by clicking on the Confirm and Finish buttons

  14. After Completion of FB Process Get Back to Gupshup page for waba phone number selection. Select phone number and click Confirm

  15. Wait for setup completion. After successful setup completion, the app is ready to use

Sync UI - To trigger history and smb_app_state_sync

ℹ️

Please note the following before you trigger Contact and History Sync events:

Before triggering the sync please ensure you have setup a callback URL or webhook URL with Coexistence mode enabled as listed below under Coexistence Webhooks section

Both smb_app_state_sync and history synchronization can be triggered only once, and must be initiated within 24 hours of onboarding.

Steps to trigger this

  1. After doing a successful embed signup with Coex, navigate to the Account tab for the specific app that you have just made live on Coex

  2. There you will get an option to trigger the sync on contacts and history events. Once inisiated, you will receive an event from Meta on the webhook URL as mentioned in the meta document here.


Coexistence Webhooks

  • Use this UI to subscribe to Coexistence Webhooks
  • More information on the Coexistence events here
ℹ️

Note regarding Media URLs in events:

For CoEx, we forward the v3 events exactly as received from Meta without any modifications. Meta now provides only the Media ID instead of a direct media URL.

Now you are ready to start messaging from Whatsapp business app and Whatsapp cloud API.

Need Support?

For any support requests, questions, or issues, please reach out to [email protected], and our team will assist you with a resolution.

❗️

Please note that most Coexistence-related issues originate on Meta's side.

Kindly set expectations accordingly, as the resolution timeline for such cases may vary and can be dependent on Meta's investigation and response.



Did this page help you?