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 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

Messaging Reference Event Reference Core Client Reference

Workspace Reference

Generated README reference pages for apps, packages, and integrations in the open-wa monorepo.

Workspace Reference

This section is generated from README files in direct child directories under apps/, packages/, and integrations/. It includes 7 app workspaces, 27 package workspaces, and 5 integration workspaces.

Apps
Packages
Integrations

Run pnpm --filter docs workspace-docs to refresh these pages after changing a workspace README.

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!

API Reference

Generated API reference for the active open-wa surface.

Apps

README reference pages for apps workspaces.

On this page

Workspace Reference