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

Packages @open-wa/api @open-wa/cf-proxy @open-wa/cli @open-wa/client @open-wa/config @open-wa/core @open-wa/decrypt @open-wa/domain @open-wa/driver-interface @open-wa/driver-lightpanda @open-wa/driver-playwright @open-wa/driver-puppeteer @open-wa/hyperemitter @open-wa/logger @open-wa/mcp @open-wa/plugin-sdk @open-wa/runtime-browser @open-wa/runtime-bun @open-wa/runtime-core @open-wa/runtime-edge @open-wa/runtime-node @open-wa/schema @open-wa/screencaster @open-wa/session-sync @open-wa/socket-client @open-wa/wa-automate-types-only @open-wa/ui-components @open-wa/utils @open-wa/wa-automate

Messaging Reference Event Reference Core Client Reference

@open-wa/runtime-node

Node Effect runtime Layer for open-wa

apps/docs/scripts/gen-workspace-readme-docs.js generated this page from packages/runtime-node/README.md. Do not edit this page directly.

@open-wa/runtime-node

Node Effect runtime Layer for open-wa

Part of the @open-wa v5 monorepo.

Development

pnpm --filter @open-wa/runtime-node build
pnpm --filter @open-wa/runtime-node test
pnpm --filter @open-wa/runtime-node lint
pnpm --filter @open-wa/runtime-node typecheck
pnpm --filter @open-wa/runtime-node clean

Documentation

See the docs site.

License

H-DNH 1.1 - 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/runtime-edge

Web API Effect runtime Layer for open-wa edge control planes

@open-wa/schema

Zod-based schema definitions for open-wa

On this page

@open-wa/runtime-node Development Documentation License