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

Client API Reference All client methods Schema pipeline BaseClient Namespaced client Argument normalization Aliases Data models Generated types Worked example: sendText Events Licensed methods Business Client API ChatIds Client API Chats Client API Communities Client API Contacts Client API Groups Client API Labels Client API Media Client API Messages Client API Mystatus Client API Session Client API Status Client API

Messaging Reference Event Reference Core Client Reference

Data models

Core data models returned by client methods.

Data models

Generated file warning: this page is generated by packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.

These are the main data models. Fields are derived from the exported types in packages/schema/src/common-types.ts.

Message

Prop

Type

Contact

Prop

Type

Chat

Prop

Type

GroupMetadata

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!

Aliases

Function aliases and parameter key aliases across all methods.

Generated types

Where the generated input/output type aliases come from.

On this page

Data models Message Contact Chat GroupMetadata