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

Config schema

Generated config type tables for the open-wa runtime, based on the current config package source of truth.

Config schema

This page exposes the current configuration surface from the schema/config source of truth instead of relying only on prose summaries.

+

How to use this page

Start with Configuration and CLI for the practical guidance, then use this page when you need the concrete field surface and type details.

Main config object

Prop

Type

Strict config

Prop

Type

Partial config

Prop

Type

Deep partial config

Prop

Type

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!

Configuration and CLI

Core runtime settings for custom code and the most important Easy API CLI flags.

Managing Secrets in Config

Handle API keys, passwords, and tokens safely in wa.config.js and pluginConfig.

On this page

Config schema Main config object Strict config Partial config Deep partial config