API WhatsApp Web API WhatsApp Web

Introduction

WhatsApp Web API - The Power of Automation!

Created by developers for developers, the WhatsApp Web API is built on simplicity and efficiency. No unnecessary complexity, straight to the point: Let's go!

So, what is the WhatsApp Web API?

If you've made it here, you probably already have an idea, but to reinforce: It is a RestFul service that allows interaction with your WhatsApp through a practical and intuitive API. Additionally, it includes webhooks for real-time notifications of your interactions.

Responsible Use

The WhatsApp Web API MUST NOT be used for SPAM, sending unsolicited messages, or any practice that violates WhatsApp's terms. The best approach is to create solutions that add value to both your clients and the platform users.

Who Can Use It?

  • Developers: Anyone with knowledge of RestFul APIs can integrate and use the services.
  • Platform Users: If you use systems that allow integration, you can take advantage of WhatsApp Web API features.
  • Automations: The platform enables direct automations without needing an API, automating simple message sending and streamlining processes with a single click.

What can be done?

Everything you already do on WhatsApp Web, now automated! Just scan the QR Code and start using the API's features.

Message Sending Flow

  1. You send a message via API to the WhatsApp Web API.
  2. The API processes the request and adds the message to a queue.
  3. WhatsApp Web sends the message to the recipient.
  4. Your Webhook receives a notification when the message is sent or fails.
  5. As soon as the message is received, a "RECEIVED" status event is triggered.
  6. When read, the "READ" status is activated on the Webhook.

Limits

There is no strict limit on message sending, but since the API is based on WhatsApp Web, it is essential to follow natural usage patterns. Additionally, we recommend reading WhatsApp’s policies on its official page: WhatsApp Terms of Service.

Attention!

The WhatsApp Web API does not store messages. They are processed and forwarded immediately for sending and are automatically deleted after 30 days.

Facebook applies different rules for each version of WhatsApp. Our API is fully compatible with the Web version.

Authentication

How Does It Work?

Authentication for the API is done through Basic HTTP Authentication. Your API key acts as the username value in Basic Auth. No password is required.

API keys have high privileges. Do not share your API keys in public areas like GitHub or client-side browser code.

Attention!

Never expose your API key in public repositories or in code accessible to third parties. This can compromise your application’s security.

Getting an API Key