Overview
Welcome to the Chatway developer docs. Use these pages to integrate Chatway into your product with the REST API and outbound webhooks.
What's in these docs
- Getting Started — Create an API key, send your first request, and learn about testing, rate limits, errors, and support.
- API Reference — Browse every REST endpoint with request and response schemas. Use Try It to send live requests from the browser.
- Webhook docs — Subscribe to real-time events such as new messages, conversation updates, and contact changes.
If you are new to Chatway, start with Quickstart. If you already have an API key, jump to any endpoint in the sidebar.
REST API
The Chatway REST API lets you read and update Chatway data programmatically using standard HTTP methods and JSON.
Base URL
https://developers.chatway.app/api/v1
Authentication
All endpoints require an API key in the X-API-KEY header. See Quickstart for key creation and your first request.
Response format
Successful responses return JSON. List endpoints are paginated with page and limit query parameters. See Pagination for defaults, limits, response shape, and sort order.
Errors use conventional HTTP status codes with a JSON message field. Validation failures include an errors object. See Errors for response bodies, 401 vs 403, and 429 / Retry-After behavior.
Resources
| Tag | What you can do |
|---|---|
| Widgets | List chat widgets in your workspace. |
| Contacts | List, retrieve, update, and initialize visitor contacts. |
| Conversations | List conversations, read messages, and resolve conversations. |
| Messages | Send new messages into a conversation. |
| Agents | List agents, retrieve agent details, and invite new agents. |
Select a tag in the sidebar to see every operation, request schema, and response example.
Real-time events
For push notifications when something happens in Chatway (new messages, conversation updates, and more), use Webhook docs in the sidebar instead of polling these endpoints.
The most common pattern is documented step-by-step in Quickstart → Receive a message and send a reply: subscribe to message.received, read data.conversation.id from the webhook, and call POST /messages to reply.
Next steps
- Quickstart: account, API key, and first request.
- Pagination: list endpoints, page sizes, and sort order.
- Errors: response bodies and status code reference.
- Testing the API: Try It, curl, and webhook testing tips.
- Rate limits: per-key limits and retry behavior.