WhatsApp omnichannel integration API

WhatsApp Business API Integration for Rocket.Chat

Getting started with Template messages

The WhatsApp app allows you to send template messages to a target user.
In order to send a template message, you have two options:

1. Via endpoint

  • REST API Documentation for this endpoint can be found here

2. Via Slash Command and UI

  • You can send the template message in a more user-friendly way using the GUI form.
  • To trigger the GUI, open a WhatsApp contact room and run the following command
    /whatsapp send-template
  • This will open up a modal, where you can select
    • The Template you wish to send,
    • The Language you wish to send the template in,
    • And also substitute parameters within the message, if present.
      Note, If parameters (i.e eg ) are present withing the template message, please make sure that you substitute all of them before sending the message. Failure to do so will result in an error.
A video demonstration of the above feature is available here:
Watch the video

Getting status of messages sent

To receive real-time status updates for outbound messages, you can choose to set a Message Status Endpoint URL. The app will send a request to this URL each time your message status changes to one of the following: queued, failed, sent, delivered, read, or if some error occurs.
You can set the Message Status Endpoint URL in the Apps Settings.
Following is the payload format you will receive on the endpoint
Field Name
String or undefined
Message Id.
Text message
Phone number of WhatsApp user to which you had sent the message
Your connected WhatsApp Number from which you had sent the message to user
Status of message - sent, delivered, read, failed, deleted
Optional Type: String or WhatsApp error format
Errors from template messages will be shown here
Template-Message or Regular-Message
Timestamp of request
Last modified 5mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.