How can we help?
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
Sends pre-approved templates, documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates#text-based.
This is a Premium Integration.
Authentication
This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type WhatsApp.
To create a key of this type:
- In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
- Click on the + Create New Key button;
- On the resulting Create New Key form, choose WhatsApp in the Type pick list;
- Give the WhatsApp KeySafe key a Title (this is the name / identifier for the WhatsApp account as you will see it when using the cloud automation node in your workflows);
- Optionally populate the Description field;
- Populate the following fields accordingly, then click the Create Key button to create your new key:
| Name | Type | Description |
|---|---|---|
| Token | string |
Permanent API Token |
Tip
To find your phone number ID access this page https://developers.facebook.com/apps/YOURAPPIDHERE/whatsapp-business/wa-dev-console/?business_id=YOURBUSINESSIDHERE and select the phone number with rights to send messages. To find your Whatsapp Business Account Id go to https://business.facebook.com/settings/whatsapp-business-accounts while logged into the facebook account with access to the integration, select whatsapp accounts, then select the integration. Under the title of the account, there will the Id.
Revoking Access
If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.
Warning
This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked WhatsApp account, so you will need to manage these workflows accordingly.
Input Parameters
| Display Name | ID | Type | Description | Required | Supported Values |
|---|---|---|---|---|---|
| Recipient Number | recipientNumber |
string |
Phone number of recipient | Yes | None provided |
| Sending Number ID | sendingNumberId |
string |
ID of the number authorized to send WhatsApp business messages. | Yes | None provided |
| Template language code | templateLanguage |
string |
Template language code (normally en_US) | Yes | None provided |
| Template Name | templateName |
string |
Name of the template to send | Yes | None provided |
| Variables | variables |
array |
Variables for the body component. | No | None provided |
Output Parameters
| Display Name | ID | Type | Description |
|---|---|---|---|
| status | status |
string |
None provided |
| error | error |
string |
None provided |
| result | result |
string |
None provided |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}