From cf9eadb2e871687d167ab776d484abe9d9958ac2 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Mon, 29 Dec 2025 14:20:39 -0500 Subject: [PATCH 1/4] wip --- .../vocabularies/botpress-vocab/accept.txt | 3 +- docs.json | 1 + .../assets/icons/chatwoot.svg | 5 ++ integrations/integration-guides/chatwoot.mdx | 56 +++++++++++++++++++ 4 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 integrations/integration-guides/assets/icons/chatwoot.svg create mode 100644 integrations/integration-guides/chatwoot.mdx diff --git a/.vale/styles/config/vocabularies/botpress-vocab/accept.txt b/.vale/styles/config/vocabularies/botpress-vocab/accept.txt index f7e8b5a1..4cc21a34 100644 --- a/.vale/styles/config/vocabularies/botpress-vocab/accept.txt +++ b/.vale/styles/config/vocabularies/botpress-vocab/accept.txt @@ -54,4 +54,5 @@ Apify Airtable Persat Mintlify -Sharepoint \ No newline at end of file +Sharepoint +Chatwoot \ No newline at end of file diff --git a/docs.json b/docs.json index b84e8840..7b523853 100644 --- a/docs.json +++ b/docs.json @@ -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", diff --git a/integrations/integration-guides/assets/icons/chatwoot.svg b/integrations/integration-guides/assets/icons/chatwoot.svg new file mode 100644 index 00000000..f4586d78 --- /dev/null +++ b/integrations/integration-guides/assets/icons/chatwoot.svg @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/integrations/integration-guides/chatwoot.mdx b/integrations/integration-guides/chatwoot.mdx new file mode 100644 index 00000000..2d72ae86 --- /dev/null +++ b/integrations/integration-guides/chatwoot.mdx @@ -0,0 +1,56 @@ +--- +title: Chatwoot +description: Add a bot to Chatwoot using the official integration. +icon: '/integrations/integration-guides/assets/icons/chatwoot.svg' +--- + +{/* vale off */} + +import integrationVersions from '/snippets/integrations/versions.mdx' +import { OpenInHub } from '/snippets/integrations/open-in-hub.jsx' +import Cards from '/snippets/integrations/cards/plus/plus-chatwoot.mdx' +import Triggers from '/snippets/integrations/triggers/plus/plus-chatwoot.mdx' + +{/* vale on */} + + + +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 + + + You will need: + + - A [published bot](/get-started/quick-start) + - A Chatwoot account ([self-hosted](https://) or [cloud](https://app.chatwoot.com/app/auth/signup?utm_source=navbar-link)) + + +### Step 1: Install the integration in Botpress + + + + In Botpress Studio, select **Explore Hub** in the upper-right corner. + + + Search for the **Chatwoot** integration, then select **Install Integration**. + + + In the **Configuration** menu, you should see three fields: + + - **API Access Token** + - **Account ID** + - **Inbox ID** + + Leave these empty for now—you'll come back to them after setting up the integration in Chatwoot. + + + Copy the integration's webhook URL (beginning in `https://webhook.botpress.cloud`). + + + +--- + +## Triggers + + From 5344df914dfa1809e2f0e83df44ceedcf0486e8c Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 6 Jan 2026 14:14:02 -0500 Subject: [PATCH 2/4] feat(integrations): add chatwoot guide --- integrations/integration-guides/chatwoot.mdx | 106 +++++++++++++++++-- 1 file changed, 98 insertions(+), 8 deletions(-) diff --git a/integrations/integration-guides/chatwoot.mdx b/integrations/integration-guides/chatwoot.mdx index 2d72ae86..d99ad3ec 100644 --- a/integrations/integration-guides/chatwoot.mdx +++ b/integrations/integration-guides/chatwoot.mdx @@ -8,8 +8,6 @@ icon: '/integrations/integration-guides/assets/icons/chatwoot.svg' import integrationVersions from '/snippets/integrations/versions.mdx' import { OpenInHub } from '/snippets/integrations/open-in-hub.jsx' -import Cards from '/snippets/integrations/cards/plus/plus-chatwoot.mdx' -import Triggers from '/snippets/integrations/triggers/plus/plus-chatwoot.mdx' {/* vale on */} @@ -23,7 +21,7 @@ The official Chatwoot integration allows users to chat with your bot through Tel You will need: - A [published bot](/get-started/quick-start) - - A Chatwoot account ([self-hosted](https://) or [cloud](https://app.chatwoot.com/app/auth/signup?utm_source=navbar-link)) + - A Chatwoot account ([self-hosted](https://developers.chatwoot.com/self-hosted) or [cloud](https://app.chatwoot.com/app/auth/signup?utm_source=navbar-link)) ### Step 1: Install the integration in Botpress @@ -41,16 +39,108 @@ The official Chatwoot integration allows users to chat with your bot through Tel - **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: - Leave these empty for now—you'll come back to them after setting up the integration in Chatwoot. + + + + + In Chatwoot, select your profile icon (bottom-left corner). + + + Go to **Profile Settings**. + + + Scroll to the **Access Token** section. - Copy the integration's webhook URL (beginning in `https://webhook.botpress.cloud`). + Copy the token, then paste it into the **API Access Token** field in Botpress. + + + + + 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/...` -## Triggers + the account ID is: + + `145294`. + + + Paste the account ID into the **Account ID** field in Botpress. + + + + + + + In Chatwoot, go to **Settings > Inboxes**. + + + Select **Add Inbox**. + + + Select **API** as the channel type. + + + Choose a name for the channel. + + + After creation, select the inbox to open its settings. + + + 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`. + + + 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: + + + + In Botpress, copy the integration's webhook URL (starting with `https://webhook.botpress.cloud`). + + + In Chatwoot, go to **Settings > Integrations > Webhooks**. + + + Select **Add New Webhook**. + + + Paste the Botpress webhook URL. + + + Select the following events: + - `message_created` + - `conversation_status_changed` + + + Select **Create Webhook**. + + - + + Your Chatwoot integration is ready. When users send a message to the provided Chatwoot inbox, it'll respond as your Botpress bot. + From 65fa79500d7c28868af74a9fd8d1c99e2a951691 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 6 Jan 2026 14:15:16 -0500 Subject: [PATCH 3/4] add new tag --- integrations/integration-guides/chatwoot.mdx | 1 + integrations/integration-guides/hunter.mdx | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/integrations/integration-guides/chatwoot.mdx b/integrations/integration-guides/chatwoot.mdx index d99ad3ec..a7a33f73 100644 --- a/integrations/integration-guides/chatwoot.mdx +++ b/integrations/integration-guides/chatwoot.mdx @@ -2,6 +2,7 @@ title: Chatwoot description: Add a bot to Chatwoot using the official integration. icon: '/integrations/integration-guides/assets/icons/chatwoot.svg' +tag: NEW --- {/* vale off */} diff --git a/integrations/integration-guides/hunter.mdx b/integrations/integration-guides/hunter.mdx index b8a90ad8..ccf181ae 100644 --- a/integrations/integration-guides/hunter.mdx +++ b/integrations/integration-guides/hunter.mdx @@ -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 */} From 11fdef489b67ba50414d1f504ebfa38b023e0ecf Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 6 Jan 2026 14:21:56 -0500 Subject: [PATCH 4/4] fix path --- docs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.json b/docs.json index 7b523853..c10ad5d7 100644 --- a/docs.json +++ b/docs.json @@ -260,7 +260,7 @@ "/integrations/integration-guides/bamboohr", "/integrations/integration-guides/canny", "/integrations/integration-guides/chat", - "integrations/integration-guides/chatwoot", + "/integrations/integration-guides/chatwoot", "/integrations/integration-guides/plus-email-notifier", "/integrations/integration-guides/github", "/integrations/integration-guides/gmail",