Welcome
This section documents the public WazzAPI API used by customer integrations. The schema covers:- read-only device listing and detail lookups
- contacts and contact groups
- message sending, status lookup, retry, and cancellation
- WhatsApp group management, messaging, and participant operations
- templates and template preview
- webhook payload definitions for inbound event deliveries
Python SDK
Use the typed Python client for fast server-side integrations.
Node.js SDK
Use the official Node.js and TypeScript SDK built around the same public API.
OpenAPI schema
View the checked-in schema used by the docs site.
API schema source
The public API schema is available from:Authentication
Public endpoints are authenticated with Bearer API keys.Scope model
API keys can be limited to the minimum capabilities your integration needs.| Scope | What it unlocks |
|---|---|
admin:read | Read-only operational data such as devices, contacts, messages, and templates |
admin:write | Broad workspace write access across public API resources |
admin:system | System-level administrative access |
contacts:write | Create, update, delete, import, sync, and group contacts |
messages:send | Send outbound messages, interactive messages, and read message history |
campaigns:write | Create and manage templates and WhatsApp group operations |
- device inventory only →
admin:read - CRM/contact sync workflows →
contacts:write - outbound messaging apps →
messages:send - reusable templates or group orchestration →
campaigns:write - full operator access →
admin:write