open-wa
DocsAPI reference

@open-wa/wa-automate

WhatsApp automation CLI and API server

@open-wa/wa-automate

@open-wa/wa-automate runs an Open-WA session and exposes its client methods through an HTTP API. It also exports the session client and createClient for applications that need direct control in the same Node.js process.

Part of the @open-wa v5 monorepo.

Install

npm install @open-wa/wa-automate@5.1.0

Start a local API server

npx @open-wa/wa-automate@5.1.0 --session-id main --host 127.0.0.1 --port 8080 --api-key replace-this-key

Scan the QR code shown in the terminal to sign in. Check http://127.0.0.1:8080/health until it reports connected: true and session.ready: true. Keep the API on loopback or a private network unless you have configured an appropriate access boundary. Connect from another Node.js application with @open-wa/socket-client.

Documentation

See the CLI reference, custom code guide, and docs site.

License

H-DNH 1.1 — Hippocratic + Do Not Harm

Was this helpful?

Your answer includes the page path and docs version.

On this page