HelpCrunch (BYOK) — connector documentation
- MCP endpoint:
https://byok-helpcrunch.connectorbay.com/mcp - REST API:
POST https://byok-helpcrunch.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec athttps://byok-helpcrunch.connectorbay.com/openapi.json - Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
- Authentication: your own HelpCrunch HelpCrunch API key (Settings > Developers > Public API; not the legacy key), sent in the
X-Upstream-Keyheader of every request (never stored, logged or cached) - Health:
https://byok-helpcrunch.connectorbay.com/health· Tool schemas:https://byok-helpcrunch.connectorbay.com/tools.json - Publisher: Unify Dynamics LLC · connectorbay.com/byok-helpcrunch · agent@connectorbay.com
What HelpCrunch (BYOK) is for
HelpCrunch (BYOK) lets an AI assistant read your own HelpCrunch data through the HelpCrunch API with a key you supply (HelpCrunch API key (Settings > Developers > Public API; not the legacy key)). Read-only: 9 tools (get_organization, list_agents, list_departments, list_applications, list_customers, get_customer, list_chats, get_chat, list_chat_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 api.helpcrunch.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by HelpCrunch. HelpCrunch 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:
- "Is my HelpCrunch team online?"
- "Who are the agents in HelpCrunch?"
- "What departments does HelpCrunch have?"
- "Which channels are connected to HelpCrunch?"
- "Who are my newest HelpCrunch customers?"
- "Show HelpCrunch customer 542335"
What it does
get_organization: Show basic HelpCrunch team information: domain and whether the team is online and chat is enabled.list_agents: List HelpCrunch agents (team members) with name, email and role.list_departments: List HelpCrunch departments with their agents.list_applications: List the HelpCrunch applications and channels (web, iOS, Android, Facebook, Instagram, Viber) with active flag.list_customers: List HelpCrunch customers (up to 100 per call) with name, email, company, phone, first and last seen time, country and tags.get_customer: Get one HelpCrunch customer by numeric id.list_chats: List HelpCrunch chats (up to 100 per call) with status, customer, assignee, department, rating and last message text.get_chat: Get one HelpCrunch chat by numeric id: status, customer, assignee, department, rating and last message.list_chat_messages: List the messages of a HelpCrunch chat, newest first (up to 100 per call), with sender, text and time.
BYOK key
You bring your own HelpCrunch HelpCrunch API key (Settings > Developers > Public API; not the legacy key) (https://docs.helpcrunch.com/en/rest-api-v1/api-setup-v1). 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 api.helpcrunch.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
- https://docs.helpcrunch.com/en/rest-api-v1 (the API this connector calls, with a BYOK key)
Live from the HelpCrunch API (api.helpcrunch.com) with a BYOK key; documentation: https://docs.helpcrunch.com/en/rest-api-v1. 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 HelpCrunch. HelpCrunch 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 HelpCrunch account.
Built for: Worldwide. Languages: English.