Developer API
The Developer API provides a unified, API-key-authenticated interface for sending messages across WhatsApp, Instagram, and Facebook Messenger, and for managing contacts, conversations, and webhooks. Use it to integrate messaging into your backend systems, CRMs, and automation workflows.
This page covers the shared basics — authentication, base URL, rate limits, and the response format. Endpoint reference is split by channel and resource:
- WhatsApp — send template messages, list templates, list conversations
- Instagram — send DMs, list conversations
- Messenger — send messages, list conversations
- Contacts — full CRUD on contacts
- Webhooks — register and manage webhook subscriptions
- Request Logs — inspect recent API requests
Authentication
All Developer API endpoints use the x-api-key header. Generate an API key from Settings → Developer → API Keys in the SuperWaba dashboard.
x-api-key: sgk_90zR•••••••••8cnV
Content-Type: application/json
Invalid API key (401):
{
"success": false,
"message": "Invalid or missing API key",
"code": "INVALID_API_KEY",
"fix": "Include a valid x-api-key header"
}
Base URL
https://app.superwaba.com/api/developer/v1
Rate Limiting & Monthly Metering
All Developer API send-message endpoints and webhook event dispatches share a single monthly event counter per organization. When the cap is reached, both send-message calls and webhook deliveries are blocked until the next billing cycle.
| Plan | Monthly Events |
|---|---|
| Insta / Starter | 5,000 |
| Growth | 10,000 |
| Pro | 50,000 |
| Enterprise | Unlimited |
Rate limit reached (429):
{
"success": false,
"message": "Monthly API event limit reached (5000/5000). Upgrade your plan for more.",
"code": "API_LIMIT_REACHED"
}
You can monitor current usage in Settings → Developer → Logs.
Response Format
All responses follow this envelope:
Success:
{
"success": true,
"data": { ... }
}
Error:
{
"success": false,
"message": "Human-readable error description",
"code": "ERROR_CODE",
"fix": "Suggested fix (when available)"
}