Developer Guide · Getting started
Developer introduction
Connect your own platform to Inboxi: send WhatsApp messages from your backend, push customer data your AI agent can use, receive real-time events, and let your team trigger actions in your system from the inbox.
The Inboxi Platform API is a REST API for the systems you already run: an LMS, a store backend, a CRM, a booking system. You call Inboxi when something happens on your side (an order is placed, a student enrolls), and Inboxi calls you back when something happens on its side (a message is delivered, data is received, an agent clicks a button). These guides explain the concepts and walk through complete integrations. For every endpoint and parameter, see the API reference.
What you can build
How it fits together
A typical integration has two directions. Your backend calls the /api/v1 endpoints with an API key. Inboxi delivers messages to your customers on their channels, and sends signed webhooks or remote-action callbacks back to your servers.
Base URL and format
| Item | Value |
|---|---|
| Base URL | https://inboxi.app/api/v1 |
| Authentication | X-API-Key: inx_live_… header on every request |
| Format | JSON in, JSON out (Content-Type: application/json) |
| Rate limit | 60 requests per minute per API key (default) |
| Plan | Growth or higher for the developer API (see API keys & permissions) |
Every response has a boolean success. Successful responses carry the result in data (or list fields such as pagination); failed ones carry error and often a message.
Where it lives in the dashboard
Everything a developer needs is under Settings › Developer Hub: keys, webhooks, the data your platform pushed, and the actions it registered.
- 1Developer Hub sits under Platform API in the Settings sidebar.
- 2Tabs: Documentation, Credentials & Setup, API Keys, Webhooks, External Data, Remote Actions.
- 3Export as PDF gives you an offline copy of the in-app developer docs.
Your first request
- 1Create an API keyOpen Settings › Developer Hub › API Keys, click + New API Key and copy the key and secret. See API keys & permissions.
- 2Store it on your serverPut it in an environment variable such as
INBOXI_API_KEY. Never ship it in browser or mobile code. - 3Call the APIList your most recent conversations to confirm the key works.
curl "https://inboxi.app/api/v1/conversations?limit=5" \
-H "X-API-Key: $INBOXI_API_KEY"A 200 with "success": true means you are connected. A 401 means the key is missing or wrong; a 403 with FEATURE_LOCKED means your plan does not include API access yet.