WhatsApp Setup

Add a bot to WhatsApp using the official integration.

The official WhatsApp integration allows your users to chat with your bot by messaging a WhatsApp number.

Setup

Basic configuration

You will need:

• A published bot
• A Facebook account

Visual learner?

Check out our WhatsApp Setup guide on YouTube for a step-by-step video guide.

1. In Botpress Studio, select Explore Hub in the upper-right corner.

2. Search for the WhatsApp integration, then select Install Integration.

3. In the Configuration menu, select Authorize WhatsApp.

4. Follow the instructions to connect Botpress to your WhatsApp account.

Additional requirements:

• While setting up your WhatsApp integration, we will ask you to create or select:

  • A Facebook business page
  • A WhatsApp business account

• After setup is complete, your business will undergo a verification process by Meta, the parent company of WhatsApp. This verification confirms the identity and eligibility of your business to use Meta’s platforms.

Manual configuration

For advanced use cases, you can use your own Meta app with our integration.

You will need:

• A Meta developer app with the . Check out the Meta developer documentation to learn more about the setup process.

Step 1: Install the integration in Botpress

1. In Botpress Studio, select Explore Hub in the upper-right corner.
2. Search for the WhatsApp integration, then select Install Integration.
3. In the Configuration menu, open the drop-down menu and select Manual Configuration.

Step 2: Configure the integration

Next, fill in the integration’s configuration fields using information from your Meta app:

Verify Token

Used by Meta to verify that you’re the real owner of the provided webhook. Can be any alphanumeric string.

Access Token

1. In your Meta app’s left sidebar, go to Use cases > Connect with customers through WhatsApp > Customize.

   If you haven’t added WhatsApp as a use case yet, select Add use cases, then Connect with customers through WhatsApp.

2. Select a WhatsApp business portfolio (if you haven’t already).

3. Go to API testing.

4. Select Generate access token, then copy the token.

5. In Botpress, paste the token into the integration’s Access Token configuration field.

Client Secret

1. In your Meta App’s left sidebar, expand the App Settings menu and select Basic.
2. In the App Secret field, select Show, then copy your secret.
3. In Botpress, paste the secret into the integration’s Client Secret configuration field.

Default Bot Phone Number ID

1. In your Meta app’s left sidebar, go to Use cases > Connect with customers through WhatsApp > Customize.

   If you haven’t added WhatsApp as a use case yet, select Add use cases, then Connect with customers through WhatsApp.

2. Select a WhatsApp business portfolio (if you haven’t already).

3. Go to API testing.

4. Under Select a ‘From’ phone number, copy the Phone number ID.

5. In Botpress, paste the ID into the integration’s Default Bot Phone Number ID configuration field.

WABA ID (WhatsApp Business Account ID)

1. In your Meta app’s left sidebar, go to Use cases > Connect with customers through WhatsApp > Customize.

   If you haven’t added WhatsApp as a use case yet, select Add use cases, then Connect with customers through WhatsApp.

2. Select a WhatsApp business portfolio (if you haven’t already).

3. Go to API testing.

4. Under Select a ‘From’ phone number, copy the WhatsApp Business Account ID.

5. In Botpress, paste the ID into the integration’s WhatsApp Business Account ID configuration field.

When you’ve filled in all the fields, select Save Configuration. This will automatically enable your integration.

Step 3: Add your webhook

Now that you’ve enabled your integration, you can add your webhook to your Meta app’s configuration:

1. In Botpress, copy the webhook URL and Verify Token from the integration’s Configuration section.
2. In your Meta app’s left sidebar, go to Use cases > Connect with customers through WhatsApp > Customize.

   If you haven’t added WhatsApp as a use case yet, select Add use cases, then Connect with customers through WhatsApp.

3. Select a WhatsApp business portfolio (if you haven’t already).

4. Go to Configuration.
5. Paste the webhook URL into the Callback URL field.
6. Paste your Verify Token in the Verify Token field.
7. Select Verify and save. Then, subscribe to the following webhook fields:

   • message_template_components_update
   • message_template_quality_update
   • message_template_status_update
   • messages
   • template_category_update

You’ve manually configured your WhatsApp integration!

For more information, check out WhatsApp’s guide on getting started with Cloud API.

Playground

If you want to test your bot’s behaviour in WhatsApp before going through the actual setup process, you can use the WhatsApp integration playground.

You will need:

• A published bot
• A WhatsApp account

1. In Botpress Studio, select Explore Hub in the upper-right corner.
2. Search for the WhatsApp integration, then select Install Integration.
3. Select Test your agent on WhatsApp.
4. Follow the instructions to set up the playground.

---

Cards

Some of the integration’s Cards use WhatsApp message templates to send messages to users.

In WhatsApp, these templates support both named and positional parameters. However, the integration currently only supports positional parameters. This means you’ll get an error if you try to provide named parameters in a Card’s conversation.templateVariablesJson field.

Here’s a reference for all Cards available with the integration:

List Message Templates

input · object

Show child attributes

status · enum<string>

Available options: APPROVED, PENDING, REJECTED, PAUSED, DISABLED, ARCHIVED, LIMIT_EXCEEDED, IN_APPEAL

Send Template Message

input · object

Show child attributes

conversation · object · required

Show child attributes

templateButtonParams · array

url

Show child attributes

type · string · required

value · string · required

quick_reply

Show child attributes

type · string · required

payload · string · required

copy_code

Show child attributes

type · string · required

code · string · required

skip

Show child attributes

type · string · required

Start Conversation

input · object

Show child attributes

conversation · object · required

Show child attributes

templateButtonParams · array

url

Show child attributes

type · string · required

value · string · required

quick_reply

Show child attributes

type · string · required

payload · string · required

copy_code

Show child attributes

type · string · required

code · string · required

skip

Show child attributes

type · string · required

---

Triggers

Here’s a reference for all Triggers available with the integration:

You can access data returned from any of these Triggers by reading event.payload after the Trigger fires.

Message Delivered

payload · object

This Trigger has no payload.

Message Failed

Message Read

payload · object

This Trigger has no payload.

Message Sent

payload · object

This Trigger has no payload.

Message Template Components Update

payload · object

Show child attributes

buttons · array

Show array item properties

button_type · enum<string> · required

Available options: CATALOG, COPY_CODE, EXTENSION, FLOW, MPM, ORDER_DETAILS, OTP, PHONE_NUMBER, POSTBACK, REMINDER, SEND_LOCATION, SPM, QUICK_REPLY, URL, VOICE_CALL

Message Template Quality Update

payload · object

Show child attributes

previous_quality_score · enum<string> · required

Available options: GREEN, RED, YELLOW, UNKNOWN

new_quality_score · enum<string> · required

Available options: GREEN, RED, YELLOW, UNKNOWN

Message Template Status Update

payload · object

Show child attributes

event · enum<string> · required

Available options: APPROVED, ARCHIVED, DELETED, DISABLED, FLAGGED, IN_APPEAL, LIMIT_EXCEEDED, LOCKED, PAUSED, PENDING, REINSTATED, PENDING_DELETION, REJECTED

reason · string | null · required

other_info · object

Show child attributes

title · enum<string> · required

Available options: FIRST_PAUSE, SECOND_PAUSE, RATE_LIMITING_PAUSE, UNPAUSE, DISABLED

Message Echo Received

payload · object

This Trigger has no payload.

Reaction Added

Reaction Removed

Template Category Update

---

Troubleshooting

Not receiving messages from bot on WhatsApp

Until Meta has verified your business, your bot won’t be able to send messages to WhatsApp users, even if you’ve configured it correctly.

If you need to test out your bot right away, you can use the WhatsApp Playground while waiting for business verification.

Meta business verification taking too long

Unfortunately, we can’t help speed up Meta’s business verification process.

If you need to test out your bot right away, you can use the WhatsApp Playground while waiting for business verification.

Bot receiving WhatsApp messages, but not sending messages back

There may be a problem with the payment method in your WhatsApp business account. Check the billing hub and make sure your payment method is configured correctly.