REST API
WhautoChat provides a robust REST API to help you integrate your workspace with external systems, automate tasks, and build custom solutions.
π What Can You Do with the REST API?β
- Send messages programmatically
- Manage contacts, conversations, and channels
- Automate workflows
- Trigger Broadcasts
- Integrate with third-party platforms (CRM, analytics, bots, etc.)
π API Hostβ
For seamless integration with WhautoChatβs services, use the correct API host for your region:
- Global: https://api.whauto.chat
To find your exact API host, go to the 'Rest API' section under 'Integrations' in your WhautoChat dashboard and copy the hostname provided. Always use the relevant host for optimal performance.
π API Key Authentication (x-api-key Header)β
All WhautoChat API requests require authentication using an API key. This ensures secure and authorized access to your workspace.
How to generate and use your API key:
- In WhautoChat, go to Integrations β REST API and generate a new API key.
- When making API requests, include your API key in the
x-api-key
header.
Example:
curl -X GET 'https://api.whauto.chat/some_endpoint' -H 'x-api-key: YOUR_API_KEY'
β±οΈ API Rate Limitsβ
To ensure fairness, stability, and security, WhautoChat enforces rate limits on all API accounts:
Type of Account | Requests per minute (RPM) | Requests per day (RPD) |
---|---|---|
Subscribed Account | 100 | 144,000 |
- Rate limits ensure fair usage and protect against abuse (e.g., DDoS attacks).
- For higher enterprise limits, contact support (additional pricing may apply).
π Getting Started with WhautoChat REST APIβ
- Go to the Integrations page in WhautoChat and select the REST API connect button.
- Copy your API Host URL using the "Copy" button.
- Click "New API Key", enter a name, and generate your API key.
- Copy your WhautoChat API key and use it in your integrations.
π§ͺ How to Test WhautoChat REST API in Postmanβ
- Download the WhautoChat REST API Postman Collection
- Open Postman, click Import, and drag in the collection files.
- Select the Environments menu and choose "WhautoChat Rest API".
- Paste the API host URL in the
host
- CURRENT VALUE field. - Paste your WhautoChat API key in the
x-api-key
- CURRENT VALUE field. - Click Save.
- Paste the API host URL in the
- Go to Collections, select "WhautoChat Rest API", and explore available endpoints.
For API documentation or integration support, contact [email protected].
For detailed troubleshooting, refer to our Troubleshooting or contact support.