WhatsApp Business On-Premises API

Business looking to use the WhatsApp Business API can host the API client in their own servers, in what we call an "On-Premises" implementation of the API.

Visit our changelog to follow what has changed in the WhatsApp Business API client and AWS Templates.

Get Started

Learn how to set up and install the WhatsApp Business API client, register a phone number, and send a test message.

Learn More

  • Client Architecture - Unlike typical REST APIs, the API requires the API Client to be installed and managed by your business. The Client consists of a set of Docker containers, as well as database and media volumes.
  • Advanced Setup - Webhooks, backup and restore, two-step verification, monitoring, availabilitya and scaling.
  • Installation - The WhatsApp Business API client can be installed as a developer setup for testing using either Docker Compose or Minikube. You can also use Amazon Web Services (AWS) on production systems.
  • Migration - Learn how to migrate an existing setup of the WhatsApp Business API client to a new setup using the same phone number.
  • Security - Passwords, authentication, SSL configuration, network segregation, encrypted communications, HTTP headers, and the web server TLS protocol as related to the WhatsApp Business API client.

Reference

The WhatsApp Business API uses a REST API Architecture with JSON data formats. The following are the main API root nodes:

NodeDescription

Account

Register your WhatsApp account

Certificates

Maintain your Certification Authority (CA) certificates for SSL configuration

Contacts

Verify customer phone numbers to generate WhatsApp IDs

Health

Check the status of your WhatsApp application

Media

Upload, delete, and retrieve media

Messages

Send text, media, message templates, and other types of messages

Metrics

Collect Webapp metrics

Services

Delete messages from the database

Settings

Set your WhatsApp application, profile, and backup and restore settings

Stats

Collect Coreapp and database stats

Stickerpacks

Manage first-party and third-party stickerpacks and stickers

Support

Get help using the WhatsApp Business API

Users

Log in to get your authentication token and manage users

Webhooks

Webhooks are user-defined HTTP callbacks that are triggered by specific events. Whenever that trigger event occurs, the WhatsApp Business API client sees the event, collects the data, and immediately sends a notification (HTTP request) to the Webhook URL specified in the application settings updating the status of sent messages or indicating when you receive a message.

Learn More