WhatsApp Business Connector Setup Guide
This article describes how to set up the WhatsApp Business connector.
API Information
This connector uses the following vendor API:
- API Name: Facebook Graph API - WhatsApp Business API
- API Version: v13.0
- API Endpoint:
https://graph.facebook.com
- Documentation: WhatsApp Business Platform Cloud API
Connector Actions
Action Name | AudienceStream | EventStream |
---|---|---|
Send Text Message | ✓ | ✓ |
Send Message Template | ✓ | ✓ |
Configure Settings
Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.
After adding the connector, configure the following settings:
- Access Token
Required. Access Token of the Facebook System User.
Click Done when you are finished configuring the connector.
Action Settings — Parameters and Options
Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.
The following section describes how to set up parameters and options for each action.
Action — Send Text Message
Parameters
Parameter | Description |
---|---|
Send From | Phone Number ID you want to send a message from. |
Send To | WhatsApp ID or phone number you want to send a message to. See Phone Numbers, Formatting for more information. |
Message | The text of the message, which can contain URLs and formatting. See the WhatsApp Business Platform Cloud API Send Text Messages documentation for usage examples. |
Preview URL | Allow URL previews in text messages. See the Sending URLs in Text Messages for more details. |
Action — Send Message Template
Parameters
Parameter | Description |
---|---|
Send From | Phone Number ID you want to send a message from. |
Send To | WhatsApp ID or phone number you want to send a message to. See Phone Numbers, Formatting for more information. |
Message Template | Provide the message template. See the WhatsApp Business Platform Cloud API Send Message Templates documentation for usage examples. The template expects a valid JSON object format. You can use template variables specified in the Message Template Variables section (see: Templates Guide). |
Message Template Variables | Provide template variables as data input for the Message Template (see: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name). Nested template variables are typically built from data layer list attributes. |
This page was last updated: October 3, 2022