Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Chatwoot Configuration (BYOK) — connector documentation

  • MCP endpoint: https://byok-chatwoot-configuration.connectorbay.com/mcp
  • REST API: POST https://byok-chatwoot-configuration.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-chatwoot-configuration.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Chatwoot Configuration Chatwoot user access token (Profile Settings), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-chatwoot-configuration.connectorbay.com/health · Tool schemas: https://byok-chatwoot-configuration.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-chatwoot-configuration · agent@connectorbay.com

What Chatwoot Configuration (BYOK) is for

Chatwoot Configuration (BYOK) lets an AI assistant read your own Chatwoot Configuration data through the Chatwoot Configuration API with a key you supply (Chatwoot user access token (Profile Settings)). Read-only: 10 tools (list_help_center_portals, get_help_center_portal, list_custom_attribute_definitions, list_automation_rules, list_saved_filters, list_campaigns, list_integration_apps, get_inbox_summary_report, get_team_summary_report, get_first_response_time_distribution). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to app.chatwoot.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Chatwoot Configuration. Chatwoot Configuration and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which help center portals do we have in Chatwoot?"
  • "How many articles does my Chatwoot help center have per language?"
  • "Which custom contact attributes are defined in Chatwoot?"
  • "What automation rules are set up in Chatwoot?"
  • "Which saved conversation filters exist in Chatwoot?"
  • "What campaigns are configured in Chatwoot?"

What it does

  • list_help_center_portals: List the help center portals of the account with name, slug, custom domain, header text, archived flag and page title.
  • get_help_center_portal: Get one help center portal by slug, including the locales it serves with article and category counts per locale.
  • list_custom_attribute_definitions: List the custom attribute definitions (key, display name, type, allowed values) for conversations or contacts.
  • list_automation_rules: List the account's automation rules (name, event, conditions and actions as stored). Paged.
  • list_saved_filters: List saved custom filters (name, type and query) for conversations, contacts or reports.
  • list_campaigns: List outbound campaigns with title, description and the inbox each belongs to (message text is not requested).
  • list_integration_apps: List the integrations available to the account (for example Slack, Dialogflow) and whether each is enabled.
  • get_inbox_summary_report: Get per-inbox totals for a time window: conversations, resolved conversations and average first response, reply and resolution times in seconds.
  • get_team_summary_report: Get per-team totals for a time window: conversations, resolved conversations and average response and resolution times in seconds.
  • get_first_response_time_distribution: Get how first response times spread across buckets for a time window (counts per inbox bucket).

BYOK key

You bring your own Chatwoot Configuration Chatwoot user access token (Profile Settings) (https://www.chatwoot.com/hc/user-guide/articles/1677509714-how-to-find-your-access-token). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to app.chatwoot.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Chatwoot Configuration API (app.chatwoot.com) with a BYOK key; documentation: https://developers.chatwoot.com/api-reference/introduction. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Chatwoot Configuration. Chatwoot Configuration and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Chatwoot Configuration account.

Built for: Worldwide. Languages: English.