open-wa
DocsAPI reference

@open-wa/core

Core orchestration backbone for open-wa WhatsApp automation

@open-wa/core

@open-wa/core creates and runs a browser-backed Open-WA session. It owns session lifecycle, events, plugins, readiness state, and the transport used by @open-wa/client to call WhatsApp Web methods. Applications can usually start with @open-wa/wa-automate, which assembles these packages behind a CLI and HTTP API.

Part of the @open-wa v5 monorepo.

Main exports

  • createClient(options) creates a session and returns an OpenWAClient with start, stop, getState, getReadiness, and getTransport methods.
  • OpenWAClient.events exposes the session event emitter.
  • Plugin, session, and transport types are also exported from this package.

The driver option is required. See the custom code guide for an example using @open-wa/driver-puppeteer, and how Open-WA works for how the packages fit together.

License

H-DNH 1.1 — Hippocratic + Do Not Harm

Was this helpful?

Your answer includes the page path and docs version.

On this page