diff --git a/_docs/_user_guide/message_building_by_channel/whatsapp.md b/_docs/_user_guide/message_building_by_channel/whatsapp.md index a2e795e0080..d3ebf4ce58b 100644 --- a/_docs/_user_guide/message_building_by_channel/whatsapp.md +++ b/_docs/_user_guide/message_building_by_channel/whatsapp.md @@ -16,6 +16,9 @@ guide_featured_list: - name: "WhatsApp Setup" link: /docs/user_guide/message_building_by_channel/whatsapp/overview image: /assets/img/braze_icons/whatsapp.svg +- name: "Bring Your Own WhatsApp Connector" + link: /docs/user_guide/message_building_by_channel/whatsapp/overview/byo_connector/ + image: /assets/img/braze_icons/whatsapp.svg - name: "WhatsApp Subscription Group" link: /docs/user_guide/message_building_by_channel/whatsapp/user_subscription/ image: /assets/img/braze_icons/table.svg diff --git a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/byo_connector.md b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/byo_connector.md new file mode 100644 index 00000000000..4b7129a4fae --- /dev/null +++ b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/byo_connector.md @@ -0,0 +1,121 @@ +--- +nav_title: BYO WhatsApp connector +article_title: Bring Your Own WhatsApp connector +page_order: 0 +description: "This reference article provides a step-by-step walkthrough for setting up a Bring Your Own WhatsApp connector, which gives Braze access to your Infobip WhatsApp Business Manager." +page_type: reference +channel: + - WhatsApp +--- + +# Bring Your Own WhatsApp connector + +> The Bring Your Own (BYO) WhatsApp connector offers a partnership between Braze and Infobip, in which you give Braze access to your Infobip WhatsApp Business Manager (WABA). This allows you to manage and pay for messaging costs directly with Infobip while using Braze for segmentation, personalization, and campaign orchestration. Braze maintains all existing functionality that the WhatsApp channel offers, such as outbound messages, inbound message processing, WhatsApp flows, and analytics. + +## Requirements + +| Requirement | Description | +| --- | --- | +| Infobip account | An Infobip account is required to use the BYO WhatsApp connector. +| Messaging credits | You consume Braze messaging credits when you send WhatsApp messages. | +| WhatsApp requirements | Complete all [WhatsApp requirements]({{site.baseurl}}/user_guide/message_building_by_channel/whatsapp/overview/#prerequisites). | +| Phone number | We suggest you [acquire a phone number through Infobip](https://www.infobip.com/docs/numbers/getting-started) for convenience. | +{: .reset-td-br-1 .reset-td-br-2 role=”presentation” } + +## Set up + +Before setting up the BYO WhatsApp connector, confirm that your WhatsApp Business Account's previous sending hasn’t been done through Infobip. + +### Supported cases + +- WhatsApp Business Account and phone number have never been connected to a partner before +- WhatsApp Business Account is connected directly to Braze through the native integration. + - Follow the steps in [WhatsApp phone number migration]({{site.baseurl}}/user_guide/message_building_by_channel/whatsapp/overview/phone_number_migration/) to migrate your phone numbers to a new WhatsApp Business Account one phone number at a time. +- WhatsApp Business Account is connected to a different solution provider from Braze and Infobip + - Follow the steps in [WhatsApp phone number migration]({{site.baseurl}}/user_guide/message_building_by_channel/whatsapp/overview/phone_number_migration/) to migrate your phone numbers to a new WhatsApp Business Account one phone number at a time. + +## Step 1: Retrieve Infobip account information {#step-1} + +1. In Infobip, identify the account that you want to use with your WhatsApp Business Account. +2. Go to **Developer Tools** > **API Keys** and select **Create API Key**. + +!["Create API key" page with a creation date of "16/12/2025" and expiration date of "16/12/36".]({% image_buster /assets/img/whatsapp/byo_connector/create_api_key.png %}) + +{: start="3"} +3. Give the key a meaningful name, such as “Braze - My Workspace Name - My WABA Name”. +4. Add an expiry date that is far into the future to avoid issues with token expiration. + - Make a note to generate a new API key and reconnect your WABA before the expiry date. +5. Select these scopes: +- `Message:send` +- `Whatsapp:manage` +- `Whatsapp:message:send` +- `Account-management:manage` +- `Subscriptions:manage` +- `Metrics:manage` +6. After creating the key, copy the API Key. + - The key can only be copied for a limited time after creation. You can repeat these steps to create a new key if you need to connect another WhatsApp Business Account in the future. + +!["Braze Example API Key" with 6 added scopes.]({% image_buster /assets/img/whatsapp/byo_connector/api_key.png %}) + +{: start="7"} +7. Copy the account API base URL. + +!["API keys" page with an API base URl highlighted.]({% image_buster /assets/img/whatsapp/byo_connector/api_base_url.png %}) + +## Step 2: Start the embedded signup + +1. In Braze, go to **Partner Integrations** > **Technology Partners** > **WhatsApp** +2. Select the **BYO Connector - Infobip** tab. + +![The WhatsApp Technology Partners page.]({% image_buster /assets/img/whatsapp/byo_connector/byo_tab_tech_parners.png %}) + +{: start="3"} +3. Enter the API key and base URL from [Step 1](#step-1). +4. Select **Connect**. +5. Proceed through the [Embedded Signup workflow]({{site.baseurl}}/user_guide/message_building_by_channel/whatsapp/overview/embedded_signup/#whatsapp-embedded-signup-workflow) with these considerations: +- You can't select the same business portfolio that is used by a different Business Solution Provider. +- You can't select a phone number that's used by another Business Solution Provider. +- You must create a new WABA, not select an existing one. + +{% alert note %} +To receive the verification code, go to your Infobip dashboard > **Analyze** > **Logs**, and pull the code from the inbound SMS message. +{% endalert %} + +![Message logs showing an inbound SMS message with the verification code.]({% image_buster /assets/img/whatsapp/byo_connector/verification_code.png %}) + +After completing setup, your phone number is listed as a subscription group under your WhatsApp Business Group. The WhatsApp Business Group contains the Infobip account name and API base URL it’s connected to. Accounts connected through the native integration do not have an Infobip account name. + +{% alert note %} +Connect each WhatsApp Business Account to a single Infobip account. Each time you connect an additional phone number or subscription group, if the WhatsApp Business Account is already connected to an Infobip account, you must re-enter the API credentials for the existing account. +{% endalert %} + +## Step 3: Sending messages + +Follow the native integration sending process, including: +- [Subscribing users to the subscription group]({{site.baseurl}}/user_guide/message_building_by_channel/whatsapp/user_subscription/) +- [Creating a WhatsApp message]({{site.baseurl}}/user_guide/message_building_by_channel/whatsapp/whatsapp_campaign/create/) + +## Troubleshooting setup + +### Couldn’t retrieve WhatsApp Business Account ID + +Confirm your WhatsApp Business Account isn’t connected to a different Braze workspace. + +### Couldn’t share WhatsApp Business Account ID with Infobip + +1. Confirm your WhatsApp Business Account isn’t connected to Braze or another partner. +2. Confirm no phone numbers in your WhatsApp Business Account are connected to a different Infobip account. For imported numbers, you can find the number in Infobip and select **Cancel number**. + +![The "Cancel number" button for an Infobip number.]({% image_buster /assets/img/whatsapp/byo_connector/cancel_number.png %}) + +## Considerations + + +While all existing functionality with Braze is supported, these use cases are currently not supported. + +| Use case | Reason | +| --- | --- | +| Processing inbound messages in Braze and Infobip | This prevents logic trains that are triggered by either system, consequently generating duplicate and potentially contradictory message threads. | +| Sending messages from Braze and Infobip | For WhatsApp Business Accounts connected to Braze, all sending originates from Braze. | +{: .reset-td-br-1 .reset-td-br-2 role=“presentation” } + diff --git a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/embedded_signup.md b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/embedded_signup.md index 6cf7e6bd8e3..95ea56a3889 100644 --- a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/embedded_signup.md +++ b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/embedded_signup.md @@ -1,7 +1,7 @@ --- nav_title: Embedded signup article_title: WhatsApp Embedded Signup -page_order: 0 +page_order: 1 description: "This reference article provides a step-by-step walkthrough for the WhatsApp embedded signup workflow in Braze." page_type: reference channel: diff --git a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/multiple_subscription_groups.md b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/multiple_subscription_groups.md index af8bb3f832a..31152a5ea08 100644 --- a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/multiple_subscription_groups.md +++ b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/multiple_subscription_groups.md @@ -1,7 +1,7 @@ --- nav_title: Multiple business accounts article_title: Multiple WhatsApp Business Accounts and Phone Numbers -page_order: 2 +page_order: 3 description: "This reference article covers the steps to add WhatsApp Business accounts and phone numbers." page_type: reference channel: diff --git a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/phone_number_acquisition.md b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/phone_number_acquisition.md index 8a249126aac..b7f8fe71f4d 100644 --- a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/phone_number_acquisition.md +++ b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/phone_number_acquisition.md @@ -1,7 +1,7 @@ --- nav_title: Phone number acquisition article_title: Phone Number Acquisition -page_order: 3 +page_order: 4 description: "This reference article covers how to acquire a phone number from Twilio and Infobip." page_type: reference channel: diff --git a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/phone_number_migration.md b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/phone_number_migration.md index e06f3f0da7d..df555a20126 100644 --- a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/phone_number_migration.md +++ b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/phone_number_migration.md @@ -1,7 +1,7 @@ --- nav_title: WhatsApp phone number migration article_title: WhatsApp Phone Number Migration -page_order: 2 +page_order: 3 description: "This reference article covers how to migrate your WhatsApp phone number." page_type: reference channel: @@ -27,5 +27,4 @@ For information on migrating your WhatsApp phone number, see Meta's documentatio 1. In the WhatsApp Manager, select the WhatsApp Business Account (WABA) associated with your phone number, then go to **Account tools** > **Phone numbers**. 2. Select **Turn off two-step verification** and complete the steps that follow.

![WhatsApp Business Manager opened to the "Phone numbers" page.]({% image_buster /assets/img/whatsapp/waba_manager.png %}){: style="max-width:80%;"}

If you’re migrating a phone number to a different WhatsApp Business Group and Meta’s embedded signup requires the display name to match, take note of the existing display name on the **Phone Numbers** page. You'll enter that name during the next step.

![The WhatsApp Business Manager's Phone Numbers page with a display name of "Braze" listed next to a phone number.]({% image_buster /assets/img/whatsapp/phone_numbers.png %}){: style="max-width:80%;"}

-3. Continue Meta’s embedded signup workflow to completion. - +3. Continue Meta’s embedded signup workflow to completion. \ No newline at end of file diff --git a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/transfer_between_workspaces.md b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/transfer_between_workspaces.md index 5879d3b8465..8b30c29887d 100644 --- a/_docs/_user_guide/message_building_by_channel/whatsapp/overview/transfer_between_workspaces.md +++ b/_docs/_user_guide/message_building_by_channel/whatsapp/overview/transfer_between_workspaces.md @@ -1,7 +1,7 @@ --- nav_title: Transfer between workspaces article_title: Transfer phone numbers and subscription groups between workspaces -page_order: 4 +page_order: 5 description: "This reference article covers how to transfer your WhatsApp phone number and subscription groups between workspaces." page_type: reference channel: diff --git a/assets/img/whatsapp/byo_connector/api_base_url.png b/assets/img/whatsapp/byo_connector/api_base_url.png new file mode 100644 index 00000000000..ff5b1a423ed Binary files /dev/null and b/assets/img/whatsapp/byo_connector/api_base_url.png differ diff --git a/assets/img/whatsapp/byo_connector/api_key.png b/assets/img/whatsapp/byo_connector/api_key.png new file mode 100644 index 00000000000..b144c1231dc Binary files /dev/null and b/assets/img/whatsapp/byo_connector/api_key.png differ diff --git a/assets/img/whatsapp/byo_connector/byo_tab_tech_parners.png b/assets/img/whatsapp/byo_connector/byo_tab_tech_parners.png new file mode 100644 index 00000000000..e765f14bb47 Binary files /dev/null and b/assets/img/whatsapp/byo_connector/byo_tab_tech_parners.png differ diff --git a/assets/img/whatsapp/byo_connector/cancel_number.png b/assets/img/whatsapp/byo_connector/cancel_number.png new file mode 100644 index 00000000000..2368b808b05 Binary files /dev/null and b/assets/img/whatsapp/byo_connector/cancel_number.png differ diff --git a/assets/img/whatsapp/byo_connector/create_api_key.png b/assets/img/whatsapp/byo_connector/create_api_key.png new file mode 100644 index 00000000000..ca1b806522c Binary files /dev/null and b/assets/img/whatsapp/byo_connector/create_api_key.png differ diff --git a/assets/img/whatsapp/byo_connector/verification_code.png b/assets/img/whatsapp/byo_connector/verification_code.png new file mode 100644 index 00000000000..e7e480918d6 Binary files /dev/null and b/assets/img/whatsapp/byo_connector/verification_code.png differ