Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. π₯π¬
Ruby actioncablechat-widgetconversationcustomer-supportdashboarddesigndockerdocker-imageherokuintercomjavascriptlivechatopensourcerailsrubysassvuejswhatsappzendesk
openapi: '3.1.0'
info:
title: Chatwoot - Application API
description: Application API endpoints for Chatwoot
version: 1.1.0
termsOfService: https://www.chatwoot.com/terms-of-service/
contact:
email: [email protected]
license:
name: MIT License
url: https://opensource.org/licenses/MIT
servers:
- url: https://app.chatwoot.com/
tags:
- name: Account AgentBots
description: Manage agent bots within accounts
- name: Agents
description: Manage agents
- name: Canned Responses
description: Manage canned responses
- name: Contacts
description: Manage contacts
- name: Contact Labels
description: Manage contact labels
- name: Conversation Assignments
description: Manage conversation assignments
- name: Conversation Labels
description: Manage conversation labels
- name: Conversations
description: Manage conversations
- name: Custom Attributes
description: Manage custom attributes
- name: Custom Filters
description: Manage custom filters
- name: Inboxes
description: Manage inboxes
- name: Integrations
description: Manage integrations
- name: Labels
description: Manage account labels
- name: Messages
description: Manage messages
- name: Profile
description: Manage user profile
- name: Reports
description: Generate reports
- name: Teams
description: Manage teams
- name: Webhooks
description: Manage webhooks
- name: Automation Rule
description: Manage automation rules
- name: Help Center
description: Manage help center
paths:
$ref: ../paths/index.yml
components:
schemas:
$ref: ../definitions/index.yml
parameters:
$ref: ../parameters/index.yml
securitySchemes:
userBearerAuth:
type: http
scheme: bearer
description: 'Authenticate with `Authorization: Bearer <token>` using a user API token from **Profile Settings**. Available in Chatwoot `v4.19.0` and later.'
agentBotBearerAuth:
type: http
scheme: bearer
description: 'Authenticate with `Authorization: Bearer <token>` using an agent bot token from **Settings β Agent Bots**. Available in Chatwoot `v4.19.0` and later.'
userApiKey:
type: apiKey
in: header
name: api_access_token
description: 'Find your API token in **Profile Settings**. The `api_access_token` header remains supported, but will be deprecated in a future release. For new integrations, use Bearer authentication.'
agentBotApiKey:
type: apiKey
in: header
name: api_access_token
description: 'Find your agent bot token in **Settings β Agent Bots**. For new integrations, use Bearer authentication in Chatwoot `v4.19.0` and later. Agent bot tokens can access only bot-permitted APIs.'