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

Freshchat (BYOK) — connector documentation

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

What Freshchat (BYOK) is for

Freshchat (BYOK) lets an AI assistant read your own Freshchat data through the Freshchat API with a key you supply (Freshchat API token (Admin > Configure > API Tokens)). Read-only: 9 tools (get_account_configuration, list_agents, list_groups, list_channels, list_roles, search_users, list_user_conversations, get_conversation, list_conversation_messages). 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 *.freshchat.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Freshchat. Freshchat 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 Freshchat plan and data center is my account on?"
  • "Which Freshchat agents are available right now?"
  • "Which groups does my Freshchat have?"
  • "Which Freshchat channels are enabled?"
  • "What roles exist in Freshchat?"
  • "Find the Freshchat customer with email jane@example.com"

What it does

  • get_account_configuration: Get the Freshchat account configuration: domain, plan type, data center and app id.
  • list_agents: List Freshchat agents with name, email, role, groups, availability and whether they are deactivated.
  • list_groups: List Freshchat groups with name, description and routing type.
  • list_channels: List Freshchat channels (topics) with name, enabled and public flags and tags.
  • list_roles: List Freshchat agent roles with name and whether the role is custom.
  • search_users: Find Freshchat customers (end users) by first name, last name, email, reference id or phone number. At least one search field is required.
  • list_user_conversations: List the ids of all Freshchat conversations of one customer.
  • get_conversation: Get one Freshchat conversation: status, channel, assigned agent and group.
  • list_conversation_messages: List the messages of one Freshchat conversation with type, sender, time and message parts (text, images, files).

BYOK key

You bring your own Freshchat Freshchat API token (Admin > Configure > API Tokens) (https://developers.freshchat.com/api/#authentication). 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 *.freshchat.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 Freshchat API (*.freshchat.com) with a BYOK key; documentation: https://developers.freshchat.com/api/. 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 Freshchat. Freshchat 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 Freshchat account.

Built for: Worldwide. Languages: English.