You can redirect the client to this URL, instead of implementing the CSAT survey component yourself.

Get CSAT survey page

Official developer documentation for Chatwoot - the open-source customer support platform. Learn about our APIs, integrations, and development guidelines.

Chatwoot Developer Docs

Learn how to use Chatwoot APIs to build integrations, customize chat experiences, and manage your installation.

Introduction

Introduction to Chatwoot APIs

List all agent bots available for the current account

List all AgentBots

Create an Agent Bot

Get the details of an agent bot in the account

Get an agent bot details

Delete an AgentBot

Update an agent bot

List Agents in Account

Add a New Agent

Remove an Agent from Account

Update Agent in Account

Get Details of Canned Responses in an Account

List all Canned Responses in an Account

Add a New Canned Response

Remove a Canned Response from Account

Update Canned Response in Account

Get details of custom attributes in an Account

List all custom attributes in an account

Add a new custom attribute

Get the details of a custom attribute in the account

Get a custom attribute details

Remove a custom attribute from account

Update custom attribute in Account

Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number

List Contacts

Create Contact

Get a contact belonging to the account using ID

Show Contact

Update a contact belonging to the account using ID

Update Contact

Delete a contact belonging to the account using ID

Delete Contact

Get conversations associated with that contact

Contact Conversations

Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number

Search Contacts

Filter contacts with custom filter options and pagination

Contact Filter

List Labels

Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.

Add Labels

Get details of automation rules in an Account

List all automation rules in an account

Add a new automation rule

Get the details of a automation rule in the account

Get a automation rule details

Remove a automation rule from account

Update automation rule in Account

List all portals in an account

Add a new portal

Update a portal

Add a new category

Add a new article

Get open, unassigned and all Conversation counts

Get Conversation Counts

List all the conversations with pagination

Conversations List

Creating a conversation in chatwoot requires a source id. 

 Learn more about source_id: https://www.chatwoot.com/hc/user-guide/articles/1677839703-how-to-create-an-api-channel-inbox#send-messages-to-the-api-channel

Create New Conversation

Filter conversations with custom filter options and pagination

Conversations Filter

Get all details regarding a conversation with all messages in the conversation

Conversation Details

Update Conversation

Toggles the status of the conversation between open and resolved

Toggle Status

Toggle Priority

Updates the custom attributes of a conversation

Update Custom Attributes

Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation.

Assign a conversation to an agent or a team

Assign Conversation

List all inboxes available in the current account

List all inboxes

Get an inbox available in the current account

Get an inbox

You can create more than one website inbox in each account

Create an inbox

Update Inbox

See if an agent bot is associated to the Inbox

Show Inbox Agent Bot

To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null

Add or remove agent bot

List Agents in Inbox

Remove an Agent from Inbox

All agents except the one passed in params will be removed

Update Agents in Inbox

Get messages

Create New Message

Delete a message and it's attachments from the conversation.

Delete a message

Get the details of all Integrations available for the account

List all the Integrations

Create an integration hook

Delete an Integration Hook

Update an Integration Hook

Fetch user profile

List all teams available in the current account

List all teams

Create a team

Get a team details

Delete a team

Update a team

List Agents in Team

Remove an Agent from Team

Update Agents in Team

List all custom filters in a category of a user

List all custom filters

Create a custom filter

Get the details of a custom filter in the account

Get a custom filter details

Delete a custom filter

Update a custom filter

List all webhooks

Add a webhook subscription to the account

Add a webhook

Delete a webhook

Update a webhook object

Get Account reports for a specific type, metric and date range

Get Account reports

Get Account reports summary for a specific type and date range

Get Account reports summary

Account Conversation Metrics

Agent Conversation Metrics

Create an Account

Get an account details

Delete an Account

Update an account

List all Account Users

Create an Account User

Delete an Account User

Create a User

Get an user details

Delete a User

Update a user

Get User SSO Link

Create a contact

Get a contact

Update a contact

List all conversations

Create a conversation

Retrieves the details of a specific conversation

Get a single conversation

Resolve a conversation

Toggles the typing status in a conversation

Toggle typing status

Updates the last seen time of the contact in a conversation

Update last seen

List all messages

Create a message

Update a message

Welcome to your new Mintlify documentation. Get started making it yours.

This is where you can describe your product's features

Features

Example overview page before API endpoints

Authentication

This endpoint gets or creates a new user.

API Reference

Application API

Platform API

Client API

Other APIs

Get CSAT survey page

Path Parameters

Response