open-wa v5 is alpha. Use v4.76.0 for mature production systems unless you are validating v5.
The Client APIAPI ExplorerLicensing
Quick StartNode.jsDockerClient APIAPI ExplorerLicensingGet a LicenseGitHubDiscordTwitter

Schema pipeline

How method schemas become the client, types, OpenAPI, and these docs.

Schema pipeline

Generated file warning: this page is generated by packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.

Every client method is defined once with defineMethodV2() and registered in clientRegistry. All downstream artifacts are projections of that single source of truth:

packages/schema/src/methods/*.ts
        |  defineMethodV2(...)
        v
  clientRegistry.getAll()
        |
        +-> gen-client-implementation.ts --> BaseClient / BaseNamespacedClient / AliasMap
        +-> gen-types.ts                 --> generated Input/Output type aliases
        +-> gen-openapi.ts               --> openapi.json
        +-> gen-client-reference-docs.ts --> these reference pages

The registry currently holds 123 methods across 12 namespaces.

Wally the Walrus typing

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!

All client methods

Alphabetical index of every client method, linking to its namespace reference.

BaseClient

The generated flat client, its dispatch contract, and the full method table.

On this page

Schema pipeline