v5 Release Status
Use the supported v5.1.0 release, understand prerelease tags, and keep existing v4 deployments available.
The npm examples on these pages pin 5.1.0. The npm registry reported latest=5.1.0 and alpha=5.0.0-alpha.8 on 2026-09-29. Docker Hub listed only its moving latest tag, so the Docker image version could not be pinned to the npm release. Choose alpha only for deliberate prerelease work.
Install v5.1.0
Easy API:
npx @open-wa/wa-automate@5.1.0 --session-id quickstart --host 127.0.0.1 --port 8080Custom code:
npm install @open-wa/wa-automate@5.1.0 @open-wa/driver-puppeteer@5.1.0Docker currently publishes only its moving latest tag; Docker image parity with npm 5.1.0 could not be pinned from the tag list checked on 2026-09-29.
Use the quick start, Docker, or Custom code page for the complete flow. A docs page returning HTTP 200 does not establish WhatsApp authentication; inspect /health and require connected: true plus session.ready: true before sending.
What v5 includes
- A monorepo package line with the runtime, API, schema, browser drivers, plugins, and integrations separated into packages.
createClientfor applications that own the embedded runtime, with the exportedClientfacade for message listeners and methods.- HTTP Easy API commands, generated API docs, and runtime event delivery through the supported server surface.
- Separate driver packages so an embedded application can choose Puppeteer or another supported driver.
- Config-driven plugins through
pluginsandpluginConfig, including the webhook and Chatwoot integrations.
Prerelease tags
The alpha dist-tag currently points to 5.0.0-alpha.8. It is a separate prerelease selection and can change independently of latest; it is not the command used by the supported-release onboarding pages. If you intentionally test it, record the exact package and image tag with your report and use a disposable account and profile.
npx @open-wa/wa-automate@alpha --session-id alpha-test --port 8080v4 archive
Existing v4 applications can continue to use the archived npm package:
npx @open-wa/wa-automate@4.76.0Docker Hub did not list a versioned v4 image tag when checked on 2026-09-29. Keep v4 configuration, examples, and session profiles separate from v5. The v4 npm package remains available for migration work; new examples on this site use 5.1.0.
Migration notes
- Start a separate v5 session with Easy API and authenticate a disposable WhatsApp account.
- Check
/healthuntilconnectedandsession.readyare both true. - Exercise the method, session recovery, plugin, and webhook flows your application needs.
- Move to embedded
createClientonly when your application must own the browser and session lifecycle; use SocketClient for a remote consumer of Easy API.
Legal and account safety
Protect session profile directories, respect rate limits, and use a separate account while evaluating a new package or prerelease.
Was this helpful?
Your answer includes the page path and docs version.
