The Chatway Public API allows you to connect your applications and services with Chatway.
Using the API, you can manage contacts, access conversations, and send messages without using the Chatway dashboard. Your system can send requests directly to Chatway to perform these actions automatically. This is useful if you want to connect Chatway with tools such as:
- CRMs
- E-commerce platforms
- Customer support tools
And more.
This is a paid feature in Chatway, and can be used within the free trial plan too. Note that if the API key is created during the free trial, it’ll be revoked once you’re on the free plan.
Please check Chatway’s official API documentation here.
What You Can Do With the Chatway API
You can use the Chatway API to automate common chat workflows. Examples include:
• Creating and updating visitor contacts
• Retrieving conversations and chat messages
• Sending messages from your system
• Resolving conversations automatically
• Synchronizing chat data with external tools such as CRMs
This allows you to integrate Chatway into your existing systems and workflows.
Generating an API Key in Chatway
To use the API, you must first create an API key. To generate it:
Step 1: Open the Chatway Dashboard and click on “Settings”:
Please note that only Admins and Owners can generate API keys.
Step 2: Click on “Developer Tools”.
Step 3: Click on the “Generate API Key” here and give your API key a name in the next step.
Step 4: After creating a key, ensure you copy and store the key securely.
Chatway will display the full API key only once when it is created. Once it’s created, you’ll only see a partial view in your dashboard. For example:
Important limits:
• You can have up to 5 active API keys
• You can revoke keys at any time
• Revoked keys cannot be restored
Authenticating API Requests
Every API request must include your API key in the request header. For example:
X-API-KEY: your_api_key_here
If the API key is missing or invalid, the request will not be processed. Instead, 401 Unauthorized will be returned. For example:
Base URL
All Chatway API requests use the following base URL:
https://developers.chatway.app/api/v1Example request URLs that you can have:
https://developers.chatway.app/api/v1/contacts (lists contacts)Rate Limits
To maintain stable performance, the Chatway API limits the number of requests. For paid plans, it’s 15 requests per minute. If your application exceeds this limit, additional requests may be temporarily rejected.
Core API Areas
The Chatway API is organized into several main areas.
Contacts
The Contacts API allows you to manage visitor information. Some example use cases can be:
| Action | Endpoint | Example Use |
| Create Contact | POST | Add a new visitor when someone signs up on your site. |
| Update Contact | PATCH | Update visitor info when they change their email or plan. |
| Get Contact | GET | Fetch the full profile and chat history of a user. |
| List Contacts | GET | Retrieve all your contacts from Chatway. |
Conversations
The Conversations API allows you to access and manage chat conversations. Example use cases can be:
| Action | Endpoint | Example Use |
| Get Conversation list | GET | Show Chatway chats inside the CRM dashboard. |
| Get Messages in a Conversation | GET | Fetch the entire chat history of a conversation |
| Resolve Conversation | POST | Automatically resolve chats when the ticket is closed in another system. |
Messages
The Messages API allows your system to send messages through Chatway, such as:
• Order confirmations
• Shipping notifications
• Support updates
For example:
| Action | Endpoint | Example Use |
| Send Message | POST | Send a thank-you message after order completion. |
Additionally, you can manipulate the widgets and the agent data using the Chatway API too.
Error Handling
If a request fails, the API returns an error response with a status code. Common status codes include:
• 200 — Request successful
• 201 — Resource created successfully
• 401 — Unauthorized request
• 404 — Resource not found
• 422 — Validation error
Check your response body for additional details about the error.
API Reference
This guide provides an overview of the Chatway API.
For full technical details, including request parameters, response examples, and schema definitions, refer to the Chatway API documentation.