support
Freshchat CLI for Shell Scripts
Use the Freshchat CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 6 read 1 write Bearer token auth
Freshchat CLI for Shell Scripts
Call integration functions from shell scripts with stable JSON input and output.
Use shell scripts for small local automations that need one or more integration calls. The Freshchat CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Freshchat CLI for Shell Scripts
kosmokrator integrations:configure freshchat --set access_token="$FRESHCHAT_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call freshchat.freshchat_list_conversations '{"page":1,"per_page":1,"status":"example_status","inbox_id":"example_inbox_id"}' --json Discovery Before Execution
Agents and scripts can inspect Freshchat docs and schemas before choosing a function.
kosmo integrations:docs freshchat --json
kosmo integrations:docs freshchat.freshchat_list_conversations --json
kosmo integrations:schema freshchat.freshchat_list_conversations --json
kosmo integrations:search "Freshchat" --json
kosmo integrations:list --json Useful Freshchat CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
freshchat.freshchat_list_conversations | Read | page, per_page, status, inbox_id | List support conversations from Freshchat. Returns paginated results with optional filters for status and inbox. Use this to find recent or unresolved conversations. |
freshchat.freshchat_get_conversation | Read | id | Get full details of a specific Freshchat conversation by ID, including messages, participants, and metadata. |
freshchat.freshchat_create_conversation | Write | user_id, initial_message, channel_id | Create a new Freshchat conversation. Specify the user ID, an initial message, and optionally a channel ID. The conversation will be started with the provided message. |
freshchat.freshchat_list_agents | Read | page, per_page | List support agents in Freshchat. Returns paginated results with agent details such as name, email, and availability status. |
freshchat.freshchat_get_agent | Read | id | Get details of a specific Freshchat agent by ID, including name, email, availability, and assigned conversations. |
freshchat.freshchat_list_groups | Read | page, per_page | List support groups (teams) in Freshchat. Groups organize agents into teams for routing conversations. |
freshchat.freshchat_get_current_user | Read | none | Get the profile of the currently authenticated Freshchat user. Useful for verifying credentials and identifying the connected account. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.