Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,5 @@ Apify
Airtable
Persat
Mintlify
Sharepoint
Sharepoint
Chatwoot
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@
"/integrations/integration-guides/bamboohr",
"/integrations/integration-guides/canny",
"/integrations/integration-guides/chat",
"/integrations/integration-guides/chatwoot",
"/integrations/integration-guides/plus-email-notifier",
"/integrations/integration-guides/github",
"/integrations/integration-guides/gmail",
Expand Down
5 changes: 5 additions & 0 deletions integrations/integration-guides/assets/icons/chatwoot.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
147 changes: 147 additions & 0 deletions integrations/integration-guides/chatwoot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
---
title: Chatwoot
description: Add a bot to Chatwoot using the official integration.
icon: '/integrations/integration-guides/assets/icons/chatwoot.svg'
tag: NEW
---

{/* vale off */}

import integrationVersions from '/snippets/integrations/versions.mdx'
import { OpenInHub } from '/snippets/integrations/open-in-hub.jsx'

{/* vale on */}

<OpenInHub integration={integrationVersions["plus/chatwoot"]}/>

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

<Info>
You will need:

- A [published bot](/get-started/quick-start)
- A Chatwoot account ([self-hosted](https://developers.chatwoot.com/self-hosted) or [cloud](https://app.chatwoot.com/app/auth/signup?utm_source=navbar-link))
</Info>

### Step 1: Install the integration in Botpress

<Steps>
<Step>
In Botpress Studio, select **Explore Hub** in the upper-right corner.
</Step>
<Step>
Search for the **Chatwoot** integration, then select **Install Integration**.
</Step>
<Step>
In the **Configuration** menu, you should see three fields:

- **API Access Token**
- **Account ID**
- **Inbox ID**
</Step>
</Steps>

### 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:

<AccordionGroup>
<Accordion title="API Access Token">
<Steps>
<Step>
In Chatwoot, select your profile icon (bottom-left corner).
</Step>
<Step>
Go to **Profile Settings**.
</Step>
<Step>
Scroll to the **Access Token** section.
</Step>
<Step>
Copy the token, then paste it into the **API Access Token** field in Botpress.
</Step>
</Steps>
</Accordion>
<Accordion title="Account ID">
<Steps>
<Step>
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>
<Step>
Paste the account ID into the **Account ID** field in Botpress.
</Step>
</Steps>
</Accordion>
<Accordion title="Inbox ID">
<Steps>
<Step>
In Chatwoot, go to **Settings > Inboxes**.
</Step>
<Step>
Select **Add Inbox**.
</Step>
<Step>
Select **API** as the channel type.
</Step>
<Step>
Choose a name for the channel.
</Step>
<Step>
After creation, select the inbox to open its settings.
</Step>
<Step>
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>
<Step>
Paste the inbox ID into the **Inbox ID** field in Botpress.
</Step>
</Steps>
</Accordion>
</AccordionGroup>

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

Finally, configure your Botpress webhook in Chatwoot:

<Steps>
<Step>
In Botpress, copy the integration's webhook URL (starting with `https://webhook.botpress.cloud`).
</Step>
<Step>
In Chatwoot, go to **Settings > Integrations > Webhooks**.
</Step>
<Step>
Select **Add New Webhook**.
</Step>
<Step>
Paste the Botpress webhook URL.
</Step>
<Step>
Select the following events:
- `message_created`
- `conversation_status_changed`
</Step>
<Step>
Select **Create Webhook**.
</Step>
</Steps>

<Check>
Your Chatwoot integration is ready. When users send a message to the provided Chatwoot inbox, it'll respond as your Botpress bot.
</Check>
1 change: 0 additions & 1 deletion integrations/integration-guides/hunter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Hunter
description: Add a bot to Hunter using the official integration.
icon: '/integrations/integration-guides/assets/icons/hunter.svg'
tag: NEW
---

{/* vale off */}
Expand Down