Skip to main content

​
WhatsApp SDK

The WhatsApp SDK is a powerful and flexible library that allows you to integrate WhatsApp messaging capabilities into your applications. Built on top of whatsapp-web.js, it provides a clean, type-safe API for interacting with WhatsApp Web.

​
Key Features

REST API

Built-in NestJS API for easy integration with web applications

TypeScript Support

Fully typed API with TypeScript for better developer experience

Authentication

Flexible authentication strategies including QR code and session management

Messaging

Rich messaging capabilities including text, media, and interactive messages

Event System

Comprehensive event system for real-time message notifications

Extensible

Modular architecture that makes it easy to extend with custom functionality

​
Architecture

The WhatsApp SDK follows a layered architecture that provides clear separation of concerns:
  1. Core Layer - Contains the adapter and types that interface directly with whatsapp-web.js
  2. SDK Layer - Provides services and implementations that build on the core layer
  3. Client Layer - Offers a public API for application developers
  4. REST API Layer - Exposes the client functionality through a REST API using NestJS
This architecture ensures that your application can use the SDK in the way that best fits your needs.

​
Getting Started

Installation

Learn how to install and set up the WhatsApp SDK in your project.

Quick Start

Create your first WhatsApp integration in minutes.

API Reference

Explore the API documentation.

Guides

Discover how to implement common use cases.