Chatwoot Conversations API API
Public conversation APIs
Chatwoot Conversations API API is one of 33 APIs that Chatwoot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Conversations API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 6 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.1.0.
Requests are made against a single base URL, https://app.chatwoot.com/.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Chatwoot Conversations API API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as api_access_token (userApiKey).
An API key is passed in the header as api_access_token (agentBotApiKey).
An API key is passed in the header as api_access_token (platformAppApiKey).
userApiKey— This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can…agentBotApiKey— This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis.platformAppApiKey— This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.
Paths & Operations 6
Across 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Public conversation APIs
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are public_contact_record (19 properties), public_message_attachment (15 properties), public_message_sender (15 properties), public_message (9 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Chatwoot 12
Other APIs Chatwoot publishes across the network.