Developer API
WhatsBox provides a RESTful developer API that enables developers to integrate WhatsApp messaging capabilities directly into external applications, custom backends, microservices, and internal tools.
For the complete API reference, endpoint definitions, authentication schemes, and interactive request explorers, visit our official developer documentation:
Official WhatsBox API Reference
Browse complete API specifications, endpoints, request schemas, and response formats at api.whatsbox.io/docs.
Managing API Keys
To authenticate API requests, you must generate a secure API Key inside the WhatsBox web application:
Open API Key Management
Click your user avatar in the bottom-left corner of WhatsBox and navigate to Settings > API Keys (/settings/api-keys).
Create a New Key
Click Create Key, provide a descriptive name (e.g. "Production Backend", "Shopify Webhook Runner"), and confirm.
Store Your Secret Key
WhatsBox generates a cryptographically secure key and displays it once:
- Copy and save the key into your environment variables or secrets manager immediately.
- For security reasons, the full key is never shown again. WhatsBox only displays the last 4 characters in the dashboard for identification.
Rotate or Revoke Keys
If a key is compromised or no longer needed:
- Click the Trash icon next to the key in the API Keys list to immediately revoke access.
- Generate a new key and update your backend environment configuration.
What Can You Build with the WhatsBox API?
Using the API and your generated key, you can:
- Trigger Notifications: Send transactional WhatsApp alerts, OTPs, booking confirmations, and shipping updates.
- Dynamic Variable Replacement: Send Meta-approved templates with populated parameters programmatically.
- Direct Session Messaging: Reply to customers within active 24-hour customer service windows.
- Contact Management: Create, update, or query contacts and audience segments from your backend.
For full technical specifications, visit https://api.whatsbox.io/docs.