- FAQ
- Introduction
- Quick Start
- Comparisons
- Disclaimer
- Requirements
- Installation
- Code Editor
- Create Your App
- Authentication
- Listen To Events
- Message Replying
- Command Handling
- Messages
- Chats
- Groups
- Contacts
- Channels
- Polls
- Orders
- Payments
- Multi Device
- Presence and Profile
Introduction
whatsapp-web.js (WWebJS) is a Node.js library for interacting with WhatsApp Web, using Puppeteer to run a managed browser and reduce blocking risk.
WWebJS has different parts:
Handles client, messages, chats, and communication with WhatsApp Web.
Utilities for sessions, authentication, and client lifecycle.
Tools for formatting messages and media.
CLI tools for setting up your app.
- What is WWebJS to understand capabilities and limits
- Disclaimer to understand risks and limitations
- Installation to prepare your environment
- Project Setup to wire events and handlers cleanly
- Authentication to pick the right session strategy for your use case
- Create Your App to structure your first project
Automatic Installation
A minimum version of Node.js 18 is required.
It will ask you the built-in steps:
Project name
Choose the name for your new project.
Select a template:
- JavaScript
- TypeScript
Use a src/ directory?
Decide whether your files should be placed in a dedicated src/ folder.
Auth strategy:
- NoAuth (no session persistence)
- LocalAuth (local session storage)
- RemoteAuth (database session storage)
Package manager
Choose your preferred package manager
npmpnpmyarn
Install dependencies automatically?
Confirm whether the CLI should install dependencies right away.
You can follow the Manual Installation guide to get started.
Enjoy!
Create your first Application
FAQ
For common questions about setup, authentication and usage, check out the FAQ.
On This Page