WhatsApp

Discover more about the WhatsApp connector and how to use it on the Digibee Integration Platform.

WhatsApp allows you to send messages to WhatsApp.

Parameters

Take a look at the configuration parameters for the connector. Parameters supported by Double Braces expressions are marked with (DB).

This connector supports the Alias parameter, which allows you to save its output and reference it later in the flow using Double Braces expressions. Learn more.

General tab

Parameter	Description	Default value	Data type
Account	The account used by the connector. Supported type: OAuth Bearer.	N/A	Account
Phone Number ID (DB)	The ID associated with your WhatsApp Business phone number, available in the WhatsApp Business dashboard.	N/A	String
Fail On Error	If enabled, interrupts the pipeline execution when an error occurs. If disabled, execution continues, but the "success" property will be set to false.	False	Boolean

Optional tab

Parameter	Description	Default value	Data type
API Version (DB)	Specifies the version of the Facebook Graph API to use.	N/A	String
Base URI(DB)	Optional. Defines a custom base URI. Useful, for example, when testing the connector with a mock WhatsApp API.	N/A	String
Webhook Path (DB)	The path where the connector will receive webhook requests.	/messages	String
To (DB)	The recipient's phone number, including the country code, area code, and number (for example, 5511999998888)	N/A	String
Message (DB)	The text content of the message to be sent.	N/A	String
Preview URL	If the message includes a URL, enabling this option displays a link preview in the message.	False	Boolean

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String

Messages flow

Input

The connector accepts any input message, being able to use it through Double Braces.

Output

The connector returns a JSON object with the following structure:

{
  "success": true,
  "body": {
    "messages": {
      "empty": false
    },
    "contacts": {
      "empty": false
    },
    "messagingProduct": "whatsapp"
  }
}

Fields description:

• success: Indicates whether the execution was successful. A value of true means the request was processed without errors.

• body.messages.empty: A boolean flag that shows whether the list of messages is empty. A value of false means the connector successfully processed at least one message.

• body.contacts.empty: Similar to the messages field, this flag indicates whether any contacts were returned. A value of false confirms that at least one contact was processed.

• body.messagingProduct: Specifies the messaging platform used. In this case, the value "whatsapp" confirms the request was handled by the WhatsApp Business API.