Build WhatsApp into whatever you already run
A REST API over the same workspace your team uses: send messages, sync contacts and leads, read analytics, and receive every event as a signed webhook.
API keys are issued per workspace by the team rather than self-served from the dashboard. Ask us and we will provision one, read-only if you prefer.
Concepts
Four things to know before your first call
Workspace-scoped keys
Every key belongs to exactly one workspace. There is no cross-workspace read, so a leaked key can never reach another tenant's data.
Messages go through Meta
Sends are relayed to the official WhatsApp Business Cloud API. Session windows and template rules are Meta's, and the API surfaces their errors verbatim.
Events, not polling
Inbound messages, status changes, lead-score updates and ticket transitions are pushed to your endpoint as signed JSON.
Idempotent writes
Send an `Idempotency-Key` header on any POST and a retry after a timeout returns the original result instead of duplicating it.
Quickstart
Three steps to your first message
Authentication is a bearer token. There is no SDK to install and no OAuth dance.
Generate a key
Go to Settings → Webhooks & API inside your workspace. Click Generate Key — it's shown once, so copy it immediately.
Add the header
Pass your key as X-Api-Key on every request. Every response is JSON; every error carries a machine-readable message.
Receive webhooks
Register an HTTPS endpoint in the same tab, verify the X-Webhook-Signature header, and acknowledge with 2xx within ten seconds.
Base URL
https://api.whatscrm.in/v1
curl -X POST https://api.waboxa.com/v1/messages \
-H "X-Api-Key: $WABOXA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+919876543210",
"text": "Your order has been dispatched."
}'curl -X POST https://api.waboxa.com/v1/messages \
-H "X-Api-Key: $WABOXA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+919876543210",
"templateName": "order_confirmed",
"variables": { "body": ["ORD-4521", "₹1,200"] }
}'{
"event": "message.received",
"workspaceId": "ws_2f9c",
"occurredAt": "2026-06-18T09:41:22.104Z",
"data": {
"conversationId": "cnv_81b3",
"contact": { "phone": "+919876543210", "name": "Rahul Kumar" },
"message": { "type": "text", "body": "Is the 2BHK still available?" }
}
}{
"error": {
"code": "template_not_approved",
"message": "Template 'order_update_v2' has not been approved by Meta.",
"status": 422,
"docs": "/api-reference#errors"
}
}Webhooks
Six events, pushed as they happen
Register one HTTPS endpoint per workspace. Every delivery carries a signature header you verify against your signing secret before trusting the body.
message.received
A customer sent a message on your WhatsApp number.
message.status
A message you sent was delivered, read or failed.
conversation.assigned
A thread was assigned to an agent or a team.
lead.scored
A lead's BANT score changed after a new message.
lead.stage_changed
A lead moved between pipeline stages.
ticket.updated
A ticket changed priority, assignee or status.
Limits & errors
What happens when things go wrong
Rate limits are per workspace, not per key. Every error response carries a stable `code` you can branch on — never only a prose message.
- Default rate limit
- 120 requests / minute / workspace
- Burst allowance
- 20 requests / second
- Webhook retry
- 5 attempts, exponential backoff over 1 hour
- Payload ceiling
- 1 MB per request body
- 429 responses include a Retry-After header in seconds.
- 5xx responses are safe to retry with the same Idempotency-Key.
- Meta's own template and session-window errors are passed through unchanged.
Looking for the endpoint list?
Every path, parameter, response shape and error code lives in the reference.
Need a key, or a hand with the first integration?
Tell us what you are building and we will provision a workspace key and answer your questions directly.