092fb2e083
Some checks failed
Lock Threads / action (push) Has been cancelled
Mark stale issues and pull requests / stale (push) Has been cancelled
Publish Chatwoot EE docker images / build (linux/amd64, ubuntu-latest) (push) Has been cancelled
Publish Chatwoot EE docker images / build (linux/arm64, ubuntu-22.04-arm) (push) Has been cancelled
Publish Chatwoot EE docker images / merge (push) Has been cancelled
Publish Chatwoot CE docker images / build (linux/amd64, ubuntu-latest) (push) Has been cancelled
Publish Chatwoot CE docker images / build (linux/arm64, ubuntu-22.04-arm) (push) Has been cancelled
Publish Chatwoot CE docker images / merge (push) Has been cancelled
Run Chatwoot CE spec / lint-backend (push) Has been cancelled
Run Chatwoot CE spec / lint-frontend (push) Has been cancelled
Run Chatwoot CE spec / frontend-tests (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (0, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (1, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (10, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (11, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (12, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (13, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (14, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (15, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (2, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (3, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (4, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (5, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (6, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (7, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (8, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (9, 16) (push) Has been cancelled
Run Linux nightly installer / nightly (push) Has been cancelled
- Add Logistics component with progress tracking - Add OrderDetail component for order information - Support data-driven steps and actions - Add blue color scale to widget SCSS - Fix node overflow and progress bar rendering issues - Add English translations for dashboard components Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
130 lines
3.8 KiB
YAML
130 lines
3.8 KiB
YAML
openapi: '3.0.4'
|
|
info:
|
|
title: Chatwoot
|
|
description: This is the API documentation for Chatwoot server.
|
|
version: 1.1.0
|
|
termsOfService: https://www.chatwoot.com/terms-of-service/
|
|
contact:
|
|
email: hello@chatwoot.com
|
|
license:
|
|
name: MIT License
|
|
url: https://opensource.org/licenses/MIT
|
|
servers:
|
|
- url: https://app.chatwoot.com/
|
|
paths:
|
|
$ref: ./paths/index.yml
|
|
components:
|
|
schemas:
|
|
$ref: ./definitions/index.yml
|
|
parameters:
|
|
$ref: ./parameters/index.yml
|
|
securitySchemes:
|
|
userApiKey:
|
|
type: apiKey
|
|
in: header
|
|
name: api_access_token
|
|
description: 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 be saved by an external system when user is created via API, to perform activities on behalf of the user.
|
|
agentBotApiKey:
|
|
type: apiKey
|
|
in: header
|
|
name: api_access_token
|
|
description: 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:
|
|
type: apiKey
|
|
in: header
|
|
name: api_access_token
|
|
description: 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.
|
|
tags:
|
|
- name: Accounts
|
|
description: Account management APIs
|
|
- name: Account Users
|
|
description: Account user management APIs
|
|
- name: AgentBots
|
|
description: Bot integrations
|
|
- name: Users
|
|
description: User management APIs
|
|
- name: Account AgentBots
|
|
description: Account-specific Agent Bots
|
|
- name: Agents
|
|
description: Agent management APIs
|
|
- name: Canned Responses
|
|
description: Pre-defined responses for common queries
|
|
- name: Contacts
|
|
description: Contact management APIs
|
|
- name: Contact Labels
|
|
description: Manage contact labels
|
|
- name: Conversation Assignments
|
|
description: Manage conversation assignments
|
|
- name: Conversation Labels
|
|
description: Manage conversation labels
|
|
- name: Conversations
|
|
description: Conversation management APIs
|
|
- name: Custom Attributes
|
|
description: Custom fields for contacts and conversations
|
|
- name: Custom Filters
|
|
description: Saved filters for conversations
|
|
- name: Inboxes
|
|
description: Communication channels setup
|
|
- name: Integrations
|
|
description: Third-party integrations
|
|
- name: Messages
|
|
description: Message management APIs
|
|
- name: Profile
|
|
description: User profile APIs
|
|
- name: Reports
|
|
description: Analytics and reporting APIs
|
|
- name: Teams
|
|
description: Team management APIs
|
|
- name: Webhooks
|
|
description: Event notification webhooks
|
|
- name: Automation Rule
|
|
description: Workflow automation rules
|
|
- name: Help Center
|
|
description: Knowledge base management
|
|
- name: Contacts API
|
|
description: Public contact APIs
|
|
- name: Conversations API
|
|
description: Public conversation APIs
|
|
- name: Messages API
|
|
description: Public message APIs
|
|
- name: CSAT Survey Page
|
|
description: Customer satisfaction survey
|
|
x-tagGroups:
|
|
- name: Platform
|
|
tags:
|
|
- Accounts
|
|
- Account Users
|
|
- AgentBots
|
|
- Users
|
|
- name: Application
|
|
tags:
|
|
- Account AgentBots
|
|
- Account
|
|
- Agents
|
|
- Audit Logs
|
|
- Canned Responses
|
|
- Contacts
|
|
- Contact Labels
|
|
- Conversation Assignments
|
|
- Conversation Labels
|
|
- Conversations
|
|
- Custom Attributes
|
|
- Custom Filters
|
|
- Inboxes
|
|
- Integrations
|
|
- Messages
|
|
- Profile
|
|
- Reports
|
|
- Teams
|
|
- Webhooks
|
|
- Automation Rule
|
|
- Help Center
|
|
- name: Client
|
|
tags:
|
|
- Contacts API
|
|
- Conversations API
|
|
- Messages API
|
|
- name: Others
|
|
tags:
|
|
- CSAT Survey Page
|