> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Chatwoot

> Add a bot to Chatwoot using the official integration.

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KD3BFCBTV2PNJ80V3VYFBC4M)
*v1.0.4*

The official Chatwoot integration allows users to chat with your bot through Telegram, WhatsApp, Email, or any Chatwoot-supported channel. It also allows your bot to hand off conversations to human agents when needed.

## Setup

> [!NOTE]
>
> You will need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * A [Chatwoot account](https://app.chatwoot.com/app/auth/signup?utm_source=navbar-link)

### Step 1: Install the integration in Botpress

**Step 1**

In Botpress Studio, select **Explore Hub** in the upper-right corner.

**Step 2**

Search for the **Chatwoot** integration, then select **Install Integration**.

**Step 3**

In the **Configuration** menu, you should see three fields:

* **API Access Token**
* **Account ID**
* **Inbox ID**

### Step 2: Get your credentials from Chatwoot

Log in to Chatwoot. Then, in Botpress, fill in the integration's configuration fields using information from your Chatwoot account:

> [accordion] API Access Token
>
> **Step 1**
>
> In Chatwoot, select your profile icon (bottom-left corner).
>
> **Step 2**
>
> Go to **Profile Settings**.
>
> **Step 3**
>
> Scroll to the **Access Token** section.
>
> **Step 4**
>
> Copy the token, then paste it into the **API Access Token** field in Botpress.

> [accordion] Account ID
>
> **Step 1**
>
> In the Chatwoot page's URL, find and copy your account ID—it should be after `/accounts/`.
>
> For example, if your page URL is:
>
> `https://app.chatwoot.com/app/accounts/145294/...`
>
> the account ID is:
>
> `145294`.
>
> **Step 2**
>
> Paste the account ID into the **Account ID** field in Botpress.

> [accordion] Inbox ID
>
> **Step 1**
>
> In Chatwoot, go to **Settings > Inboxes**.
>
> **Step 2**
>
> Select **Add Inbox**.
>
> **Step 3**
>
> Select **API** as the channel type.
>
> **Step 4**
>
> Choose a name for the channel.
>
> **Step 5**
>
> After creation, select the inbox to open its settings.
>
> **Step 6**
>
> In the Chatwoot page's URL, find and copy your inbox ID—it should be after `/inboxes/`.
>
> For example, if your page URL is:
>
> `https://app.chatwoot.com/app/accounts/1/settings/inboxes/88275`
>
> the inbox ID is `88275`.
>
> **Step 7**
>
> Paste the inbox ID into the **Inbox ID** field in Botpress.

### Step 3: Configure your webhook in Chatwoot.

Finally, configure your Botpress webhook in Chatwoot:

**Step 1**

In Botpress, copy the integration's webhook URL (starting with `https://webhook.botpress.cloud`).

**Step 2**

In Chatwoot, go to **Settings > Integrations > Webhooks**.

**Step 3**

Select **Add New Webhook**.

**Step 4**

Paste the Botpress webhook URL.

**Step 5**

Select the following events:

* `message_created`
* `conversation_status_changed`

**Step 6**

Select **Create Webhook**.

> [!TIP]
>
> Your Chatwoot integration is ready. When users send a message to the provided Chatwoot inbox, it'll respond as your Botpress bot.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.