open-wa v5 is alpha. Use v4.76.0 for mature production systems unless you are validating v5.

The Client API API ExplorerLicensing

Quick Start Node.js Docker Client API API Explorer Licensing Get a License GitHub Discord Twitter

The Client API API Explorer

Licensing open-wa docs

Quick start Link-code login Easy API quick start Custom code Docker v5 Alpha Status

Start here

Integrations Overview Understanding Chat IDs Authentication Flow

Messaging & data

Messages and message events Media Groups Group vs DM Handling Deleting Messages Session events Multiple sessions

Integration patterns

Webhooks for Business Node-RED Integration S3 Media Storage MCP integration AI Agent Patterns

Configuration

Configuration and CLI Config Explorer Config schema Managing Secrets in Config

Safety & limits

Rate Limits and Ban Risk Logging and Audit Trails

Start here

Plugin getting started Plugin Security Model Anatomy of a Plugin

Examples

Example: voice note transcription Example: OpenAI moderation

Reference

PluginInput Breakdown Hooks reference PluginClient Reference

Advanced surfaces

Dashboard Pages HTTP Routes in Plugins AI Tools External API Patterns

Publishing

Publishing a Plugin

Workspace Reference

Apps @open-wa/cli-app @open-wa/dashboard-neo @open-wa/docker docs @open-wa/orchestrator-cli @open-wa/orchestrator-dashboard registry

Messaging Reference Event Reference Core Client Reference

docs

docs workspace in the open-wa v5 monorepo.

Generated from apps/docs/README.md by apps/docs/scripts/gen-workspace-readme-docs.js. Do not edit this page directly.

docs

Fumadocs and TanStack Start documentation site for the open-wa v5 monorepo.

Part of the @open-wa v5 monorepo.

Development

pnpm --filter docs dev
pnpm --filter docs build
pnpm --filter docs start
pnpm --filter docs types
pnpm --filter docs check
pnpm --filter docs lint
pnpm --filter docs workspace-docs
pnpm --filter docs format
pnpm --filter docs copy
pnpm --filter docs openapi

Documentation

See the docs site.

License

H-DNH V1.0 - Hippocratic + Do Not Harm

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!

@open-wa/docker

This is a simple app that will expose an API that you can use to control your whatsapp instance.

@open-wa/orchestrator-cli

Multi-session orchestration CLI

On this page

docs Development Documentation License