Title: open-wa v5 docs
Open Graph Title: open-wa v5 docs
X Title: open-wa v5 docs
Description: The most reliable WhatsApp automation library — Easy API, embedded runtime, plugins, MCP, and integrations.
Open Graph Description: The most reliable WhatsApp automation library — Easy API, embedded runtime, plugins, MCP, and integrations.
X Description: The most reliable WhatsApp automation library — Easy API, embedded runtime, plugins, MCP, and integrations.
Domain: openwa.dev
| og:image | https://openwa.dev/og/docs/image.webp |
| twitter:card | summary_large_image |
| twitter:image | https://openwa.dev/og/docs/image.webp |
Links:
| open-wa | https://openwa.dev/ |
| The Client API | https://openwa.dev/docs/reference/client/client |
| Discord | https://discord.gg/dpan7EYE3t |
| https://github.com/open-wa/wa-automate-nodejs | |
| Send your first message | https://openwa.dev/docs/getting-started/quickstart |
| Choose your path | https://openwa.dev/docs |
| Fastest pathRun the Easy APIStart the API, authenticate WhatsApp, open the live docs, and send one test message.Best forI need an API todayTime5-10 minutesYou needPhone login, API key, local portAvoid ifYour Node app must own browser lifecycle and driver choice.Wrong path symptomYour app fights the API process for runtime ownership.Blocked?Check configuration, auth readiness, or the API Explorer.CLI runtime, API key, generated docsOpen guide -> | https://openwa.dev/docs/getting-started/quickstart |
| Library modeEmbed the runtimeUse createClient in Node.js when your app must own the session lifecycle.Best forI already have a Node.js appTimeDeep integration pathYou needcreateClient, browser driver, lifecycle handlersAvoid ifYou only need a hosted API another service can call.Wrong path symptomSetup stalls while you wire browser details you do not need.Blocked?Start with the runtime model before adding handlers.createClient, drivers, eventsOpen guide -> | https://openwa.dev/docs/getting-started/custom-code |
| Remote consumerConnect remotelyConnect a worker, dashboard, bot, or service to an Easy API session.Best forI already have a bot, worker, or CRMTimeAfter Easy API is runningYou needRunning Easy API, API key, reachable URLAvoid ifNo Easy API process owns the WhatsApp session yet.Wrong path symptomThe consumer connects but no session is ready.Blocked?Verify session events and API key configuration.SocketClient, RPC, SSE eventsOpen guide -> | https://openwa.dev/docs/client-and-integrations/socket-client |
| Pick ownershipRuntime modelSee which process owns the browser, API, events, and consumers. | https://openwa.dev/docs/concepts/how-it-works |
| Stay readySession eventsHandle QR auth, link-code login, readiness, logouts, and lifecycle signals. | https://openwa.dev/docs/guides/session-events |
| OperationsMulti-session opsRun named accounts with clear ports, process boundaries, and recovery paths. | https://openwa.dev/docs/guides/multiple-sessions |
| Core workMessages and mediaBuild message, media, group, and file flows from the task-based guides. | https://openwa.dev/docs/guides/messages |
| ConnectorsIntegrationsSend WhatsApp events into Chatwoot, webhooks, S3, Node-RED, or a proxy. | https://openwa.dev/docs/client-and-integrations/chatwoot |
| API lookupFind an exact methodLook up exact methods after you know the task you want to run. | https://openwa.dev/docs/reference/client |
| 1. Configure runtime and API key | https://openwa.dev/docs/guides/configuration-and-cli |
| 2. Handle auth and session readiness | https://openwa.dev/docs/guides/session-events |
| 3. Add event handling and message flows | https://openwa.dev/docs/guides/messages |
| 4. Check proxy and deployment setup | https://openwa.dev/docs/client-and-integrations/cf-proxy |
| 5. Confirm license-gated features | https://openwa.dev/docs/licensing/licensed-features |
| 6. Add monitoring and recovery notes | https://openwa.dev/docs/operations-and-troubleshooting/best-practices |
Viewport: width=device-width, initial-scale=1