Guides
Practical tutorials for setting up clients, building flows, and integrating with the API
Use these guides when you want a task-oriented path rather than a full reference page.
Connect a WhatsApp Client
Create a client, scan the QR code, understand worker status, and recover from common connection issues.
Build Your First Flow
Create a keyword-triggered WhatsApp flow with branching, user input, and a clean terminal path.
API Keys and External Calls
Create dashboard API keys and call WP Engine from cURL, TypeScript, and Python.
Node Reference
Review every node type available in the visual flow editor.
Recommended path
- Start with Getting Started if this is your first deployment.
- Connect a real client with Connect a WhatsApp Client.
- Build and publish a useful automation with Build Your First Flow.
- Add external integrations with API Keys and External Calls.
Operational notes
| Area | What to know |
|---|---|
| Clients | Each WhatsApp client runs as a separate server worker process |
| Flows | Only published flows assigned to a client react to messages |
| Contacts | Group, broadcast, and channel JIDs are ignored by ingestion |
| API keys | Use x-api-key; free keys are rate-limited at 100 requests/hour |
| Proxies | Proxy seeding is admin-only and restarts affected workers |