Skip to main content

Chatwoot APIs

Chatwoot provides three types of APIs. This distinction is primarily based on the specific use cases for which these APIs are designed.

  1. Application APIs
  2. Client APIs
  3. Platform APIs

Ref: Chatwoot API Docs

Application APIs​

Application APIs are designed to interact with a Chatwoot account from a user's perspective. These APIs will help in building integrations for the support agents, bulk import/export of data into a Chatwoot account etc.

To authenticate to this API, you will require a user access_token, which can be obtained from profile_settings after logging into your Chatwoot account. These APIs are available on both cloud and self-hosted Chatwoot Accounts.

Ref: Postman Collection

Example Implementations​

Client APIs​

The client APIs allow users to build custom conversational interfaces over Chatwoot. Not happy with the native Chatwoot Website widget? Want to create a customer Chat support option right into your mobile app? Client APIs are here to help.

Client APIs use a combination of inbox_identifier and contact_identifier for authentication. The inbox_identifier can be obtained from the Settings->Configuration of API inboxes in Chatwoot. The contact_identifier can be obtained from the server on successful contact Create API requests, which can be cached to perform subsequent requests on behalf of the contact.

These APIs are available on both cloud and self-hosted Chatwoot Accounts.

Ref: Postman Collection

Example Implementations​

Platform APIs​

The installation admin can use these APIs to manage users, accounts, and roles. These APIs could also be used to sync auth information from external systems into chatwoot. These APIs are particularly helpful if you plan to build a conversation management interface into your existing software stack.

To authenticate these APIs, you must have an access_token issued on behalf of a Platform app. You can create a Platform App from Super Admin Console. The access_token can also be obtained from the Access Tokens tab in Super Admin Console.

These APIs are available on self-hosted Chatwoot installations.

Ref: Postman Collection