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

Generated types

Where the generated input/output type aliases come from.

Generated types

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

gen-types.ts emits input and output type aliases for every method from its inputSchema and outputSchema into packages/schema/src/generated/types.ts. @open-wa/wa-automate-types-only re-exposes this generated surface so consumers can import method types without the runtime.

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!

Data models

Core data models returned by client methods.

Worked example: sendText

Following one method from schema definition to dispatch.

On this page

Generated types