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

Your comprehensive guide to installing, configuring, developing with, and integrating Chatwoot - the open-source customer support platform.

Introduction

Welcome to Chatwoot Developer Docs

Complete guide to install and setup a production-ready Chatwoot instance on your own infrastructure.

Self-Hosted Installation Guide

Understanding Chatwoot's production architecture and deployment requirements

Architecture

Chatwoot Production Deployment Guide

Hardware and software requirements for self-hosting Chatwoot

Requirements

System Requirements

Deploy Chatwoot on Ubuntu 24.04 LTS using the automated installation script

Linux VM

Production deployment guide for Linux VM

Deploy Chatwoot using Docker containers for production environments

Docker

Docker Chatwoot Production deployment guide

Deploy Chatwoot on Kubernetes using our official Helm charts

Kubernetes

Deploy Chatwoot on Kubernetes using Helm Charts

CLI tool to install and manage a self hosted Chatwoot Linux installation

Chatwoot CTL

Azure

Azure Chatwoot deployment guide

Deploy Chatwoot on a single droplet in DigitalOcean

DigitalOcean

DigitalOcean Chatwoot deployment guide

GCP Chatwoot deployment guide

Deploy Chatwoot on Heroku with one-click deployment

Heroku

Heroku Chatwoot Production Deployment Guide

Complete reference for Chatwoot environment variables and configuration options

Environment Variables

Configure Facebook Messenger integration for Chatwoot

Facebook

Setting Up Facebook

Set up Instagram integration using Facebook Login authentication

Instagram via Facebook Login

Set up Instagram integration using Instagram Business Login authentication (recommended method)

Instagram via Instagram Business Login

Configure Slack integration to receive Chatwoot conversations in Slack channels

Slack

Setting Up Slack Integration

Configure Linear integration to track issues and features from Chatwoot

Linear

Setting Up Linear Integration

Configure Shopify integration to track orders and customer information from Chatwoot

Shopify

Setting Up Shopify Integration

Step-by-step guide to upgrade Chatwoot across different deployment methods

Upgrade

Upgrading your Chatwoot installation

Complete guide to backing up and restoring your Chatwoot installation data

Backup

Backing Up Your Chatwoot Installation

Learn how to migrate your Chatwoot database from bundled PostgreSQL to managed database services like AWS RDS

How to migrate Chatwoot database?

Complete guide for upgrading to Chatwoot v4 with PostgreSQL pgvector support

How to upgrade to Chatwoot v4?

Guide to customizing email notification templates in self-hosted Chatwoot installations

Email Notifications

Customize email notifications in Chatwoot

Guide to enabling IP address geocoding and location identification in Chatwoot

Enable IP Logging

How to enable IP identification in Chatwoot?

Learn about Chatwoot's telemetry data collection, what data is collected, how it's used, and how to opt-out

Telemetry

Learn how to manage and configure Chatwoot Enterprise Edition features including licensing, pricing, and advanced capabilities

Managing Enterprise Edition Features

Comprehensive reference for supported features, message types, and limitations across all Chatwoot channels

Supported Features on Channels

Configuration guide for deploying Chatwoot in environments with restricted internal networks

Running Chatwoot in Restricted Instances

Complete guide for submitting Instagram App Review request to get advanced messaging permissions for Chatwoot integration

Instagram App Review

Common questions and answers about self-hosted Chatwoot installation, support, and best practices

Frequently Asked Questions

Complete guide to contributing to Chatwoot - from setting up your development environment to submitting pull requests.

Contributing to Chatwoot

Complete guide to setting up your macOS development environment for Chatwoot contribution.

macOS Setup

macOS Development Setup

Complete guide to setting up your Ubuntu development environment for Chatwoot contribution.

Ubuntu Setup

Ubuntu Development Setup

Complete guide to setting up your Windows development environment for Chatwoot contribution using WSL2.

Windows Setup

Windows Development Setup

Complete guide to setting up Chatwoot development environment using Docker and Docker Compose.

Docker Setup

Docker Development Setup

Speed up your local development workflow with Make commands for Chatwoot.

Make Setup

Make Commands Setup

Complete guide to setting up and running Chatwoot in development mode

Setup Guide

Project Setup Guide

Complete guide to environment variables for Chatwoot development and testing

Environment Variables for Development

Troubleshooting guide for common errors during Chatwoot development setup

Common Errors

Common Errors and Solutions

Setup Telegram app integration on your local machine for development

Telegram Setup

Telegram App Integration Setup

Setup Line app integration on your local machine for development

Line Setup

Line App Integration Setup

Setup guide for Chatwoot mobile app development

Mobile App Setup

Mobile App Development Setup

Guide to running Cypress end-to-end tests for Chatwoot

Cypress Testing

End-to-end testing with Cypress

Chatwoot APIs

API Documentation

Chatwoot Platform APIs

How to report security vulnerabilities in Chatwoot

Security Reports

Reporting Security Issues

Guide to translating Chatwoot using Crowdin translation platform

Translation Guidelines

Translate Chatwoot to Your Language

Guidelines for participating in the Chatwoot community across all platforms

Community Guidelines

Chatwoot Community Guidelines

Code of conduct for Chatwoot community members and contributors

Code of Conduct

Contributor Covenant Code of Conduct

Meet the amazing people who contribute to Chatwoot

Contributors

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

Getting Started

Application APIs

Platform APIs

Client APIs

Other APIs

Get CSAT survey page

Path Parameters

Response