open-wa v5 is alpha. Use v4.76.0 for mature production systems unless you are validating v5.
The Client APIAPI ExplorerLicensing
Quick StartNode.jsDockerClient APIAPI ExplorerLicensingGet a LicenseGitHubDiscordTwitter

open-wa docs

Start the Easy API, write custom Node.js code, connect integrations, and find the API reference.

Map Wally

open-wa / wa-automate

Use these docs to get a WhatsApp session running, connect it to your app or helpdesk, and look up exact API methods when you need them.

What you can build

  • Customer support inboxes that sync WhatsApp into your own tools
  • Order, booking, and delivery notifications from internal systems
  • Bots that react to messages, group activity, and runtime events
  • Webhook bridges for CRMs, helpdesks, automations, and low-code tools
  • Multi-session automations with named accounts and isolated consumers
  • AI-agent workflows through the built-in Model Context Protocol server

Prerequisites

  • Node.js >= 22.21.1
  • npm or pnpm (pnpm >= 10.25.0 for repo development)
  • A WhatsApp account on a phone that can stay connected

v5 alpha status

The current stable line is v4.76.0. v5 is the new package line, but it is still alpha:

# Production: use v4
npx @open-wa/wa-automate@4.76.0

# Testing: use v5 alpha
npx @open-wa/wa-automate

What changed in v5

  • Monorepo architecture with separate packages
  • Pluggable browser drivers (Puppeteer, Playwright, Lightpanda)
  • createClient as the new public contract
  • Plugin system with SDK for reusable integrations
  • Built-in MCP server for AI agent integration

When to use v5 vs v4

  • v4: Production systems, mature deployments, existing integrations
  • v5: Testing new features, contributing to development, fresh projects willing to track alpha changes

Start here

  • Use Quick start if you want to start the API, authenticate WhatsApp, and send your first message.
  • Use Custom Code if you are embedding the library in your own Node.js project.
  • Use Socket Client if you want to connect to a remote Easy API instance.
  • Use Cloudflare Session Proxy if you want remote session access without exposing a public port.

Documentation map

  • Getting Started, first-run guides for Quick start, Easy API, Docker, custom code, and link-code login.
  • Guides, practical guides for config, events, sessions, messages, media, and groups.
  • Client & Integrations, SocketClient, Chatwoot, proxying, and Cloudflare session proxy.
  • Concepts, the runtime model and core terminology.
  • API Reference, generated API docs from the active reference set.
  • Operations & Troubleshooting, error handling, logout recovery, and production best practices.
  • Licensing, licensed features and feature-availability notes.
  • Using automation tools carries a risk of account restriction or ban
  • Check your local laws regarding cryptographic software before use
  • See the Hippocratic + Do Not Harm License for full terms

Support

If you came from the old docs

Start from the task you need to finish. Use Easy API for a running local API, Custom Code for createClient, Socket Client for remote consumers, and the generated reference for exact methods.

Wally the Walrus typing

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!

Quick start

Start the Easy API, connect WhatsApp, open the docs, and send a test message.

On this page

open-wa / wa-automateWhat you can buildPrerequisitesv5 alpha statusWhat changed in v5When to use v5 vs v4Start hereDocumentation mapLegal and Risk ContextSupportIf you came from the old docs