Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Templates / Send Template

  • Article
  • 2 minutes to read

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 Status, can be OK or FAILED.
Error error string The error message from ana failed API call.
Result result string The API response.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document