API Reference Introduction
Integrate Omni Chat Stack into your backend systems using our REST Developer API, consistent JSON response envelopes, and signed outbound webhooks.
Base URL & standard response envelope
All Omni Chat Stack API endpoints are served over HTTPS under `/api/v1` (configured via your backend API host, e.g., `https://api.omnichatstack.com/api/v1`). Every endpoint returns a predictable JSON envelope:
{
"success": true,
"data": {
"messageId": "wamid.HBgLMT..."
}
}Plan eligibility & quickstart links
Paid plan requirement
The Developer API (/api/v1/developer/*) is available on all paid plans (WhatsApp API, AI Chat, Voice Ready, AI Chat & Voice, and AI Complete). Workspaces on Starter receive HTTP 403 PLAN_UPGRADE_REQUIRED.
Authentication & API Keys
Generate oc_... keys, pass X-API-Key or Bearer headers, and rotate keys safely.
POST /developer/whatsapp/messages
Send WhatsApp text, image, video, audio, or document messages programmatically.
Outbound Webhooks & HMAC
Forward inbound WhatsApp events with X-OmniChat-Signature verification.
Errors & Rate Limits
Inspect HTTP error codes, workspace rate limits, and safe retry rules.