v5 Release Status

The npm examples on this page 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 the example versionCopy Anchor Link

npx @open-wa/wa-automate@5.1.0 --session-id quickstart --host 127.0.0.1 --port 8080

The Docker guide uses the only listed image tag, latest, which can move independently of npm 5.1.0.

The getting-started pages add persistent profiles, API keys, readiness checks, and first-message steps. /api-docs/ proves that the HTTP route is live; require /health to report connected: true and session.ready: true before calling messaging methods.

What changed in v5Copy Anchor Link

• The project is a monorepo with separate runtime, API, schema, browser-driver, plugin, and integration packages.
• Embedded applications create the runtime with createClient and use the exported Client facade for lifecycle and message methods.
• Easy API commands use HTTP and expose generated API docs, while runtime events are available through the supported event surfaces.
• Browser drivers are separate packages, so embedded applications can choose the driver that fits their environment.
• Plugins load from plugins and receive their validated settings from pluginConfig.

Alpha tagsCopy Anchor Link

The alpha dist-tag currently points to 5.0.0-alpha.8. Select it only for deliberate prerelease work, record the exact tag in reports, and use a disposable account and session profile:

npx @open-wa/wa-automate@alpha --session-id alpha-test --port 8080

Prerelease selection does not change the supported release used by the main onboarding journey.

v4 archiveCopy Anchor Link

Keep existing v4 applications on their archived npm package while you migrate:

npx @open-wa/wa-automate@4.76.0

Docker Hub did not list a versioned v4 image tag when checked on 2026-09-29. Keep v4 configuration and session profiles separate from v5. New npm examples on this site target 5.1.0.

Safe migration sequenceCopy Anchor Link

1. Start a separate v5 session with Easy API and authenticate a disposable WhatsApp account.
2. Wait for /health to show both connected: true and session.ready: true.
3. Exercise the message, recovery, plugin, and webhook flows your application needs.
4. Use embedded createClient only when your application must own the browser and session lifecycle; use SocketClient for a remote Easy API consumer.