Skip to main content
Welcome to the Sapot Chat API documentation. Whether you’re building custom workflows for your support team or integrating Sapot Chat into your product, our APIs provide the flexibility and power to help you do more with Sapot Chat. Sapot Chat provides two categories of APIs, each designed with a specific use case in mind:
  • Application APIs – For account-level automation and agent-facing integrations.
  • Client APIs – For building custom chat interfaces for end-users

​
Application APIs

Application APIs are designed for interacting with a Sapot Chat account from an agent/admin perspective. Use them to build internal tools, automate workflows, or perform bulk operations like data import/export.
  • Authentication: Requires a user access_token, which can be generated from Profile Settings after logging into your Sapot Chat account.
  • Availability: Supported on both Cloud and Self-hosted Sapot Chat installations.
  • Example: Google Cloud Functions Demo

​
Client APIs

Client APIs are intended for building custom messaging experiences over Chatwoot. If you’re not using the native website widget or want to embed chat in your mobile app, these APIs are the way to go.
  • Authentication: Uses inbox_identifier (from Settings → Configuration in API inboxes) and contact_identifier (returned when creating a contact).
  • Availability: Supported on both Cloud and Self-hosted Sapot Chat installations.
  • Examples:
Use the right API for your use case, and you’ll be able to extend, customize, and integrate Sapot Chat into your stack with ease.

​
FAQ

​
What should I do if the API documentation appears outdated?

If you encounter discrepancies between the API documentation and actual API behavior, we recommend inspecting the actual requests made by the Sapot Chat UI through your browser’s developer console Network tab to see the exact request format and payload structure that works with the current API, then replicate the same request structure in your integration. You can contribute back by submitting a pull request with documentation corrections or by raising an issue in our GitHub repository to help keep our API documentation current for everyone.