Docs API reference Integrations Changelog

API Explorer Licensing GitHub Discord

Docs API reference Integrations Changelog

Start here

Integrations Overview Understanding Chat IDs Authentication and session recovery

Messaging & data

Messages and message events Interactive messages Media Groups Group vs DM Handling Deleting Messages Session events Multiple sessions

Integration patterns

Webhooks for Business Node-RED integration S3 media storage MCP integration AI Agent Patterns

Configuration

Configuration and CLI Config Explorer Config schema Managing Secrets in Config

Safety & limits

Rate Limits and Ban Risk Logging and audit trails

Docs / Config schema

Config schema

Generated config type tables for the open-wa runtime, based on the current config package source of truth.

Config schema

This page exposes the current configuration surface from the schema/config source of truth instead of relying only on prose summaries.

How to use this page

Start with Configuration and CLI for the practical guidance, then use this page when you need the concrete field surface and type details.

Primary config object

Prop

Type

Strict config

Prop

Type

Partial config

Prop

Type

Deep partial config

Prop

Type

Was this helpful?

Your answer includes the page path and docs version.

Config Explorer

Every open-wa config option and the CLI or environment adapters that actually support it.

Managing Secrets in Config

Load API keys and integration secrets explicitly through environment variables and pluginConfig.

On this page

Primary config object Strict config Partial config Deep partial config