other
Helpscout CLI for Headless Automation
Use the Helpscout CLI for headless automation with headless JSON commands, schema discovery, credentials, and permission controls.
10 functions 7 read 3 write Bearer token auth
Helpscout CLI for Headless Automation
Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers.
Use headless automation when another tool needs a stable local command surface. The Helpscout CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Helpscout CLI for Headless Automation
kosmokrator integrations:configure helpscout --set access_token="$HELPSCOUT_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call helpscout.helpscout_list_conversations '{"mailbox":1,"status":"example_status","assignee":1,"customer":1,"tag":"example_tag","page":1,"per_page":1,"sort_field":"example_sort_field"}' --jsonDiscovery Before Execution
Agents and scripts can inspect Helpscout docs and schemas before choosing a function.
kosmo integrations:docs helpscout --json
kosmo integrations:docs helpscout.helpscout_list_conversations --json
kosmo integrations:schema helpscout.helpscout_list_conversations --json
kosmo integrations:search "Helpscout" --json
kosmo integrations:list --jsonUseful Helpscout CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
helpscout.helpscout_list_conversations | Read | mailbox, status, assignee, customer, tag, page, per_page, sort_field, sort_order, query | List support conversations from HelpScout. Supports filtering by mailbox, status, assignee, customer, and more. Returns paginated results. |
helpscout.helpscout_get_conversation | Read | id | Get full details of a specific HelpScout conversation, including threads, customer info, and custom fields. |
helpscout.helpscout_create_conversation | Write | subject, mailbox_id, customer_id, customer_email, body, type, status, assignee_id, tags, cc, bcc | Create a new conversation in HelpScout. Requires a subject, customer, mailbox, and at least one thread (message or note). |
helpscout.helpscout_update_conversation | Write | id, status, subject, assignee_id, mailbox_id, tags | Update an existing HelpScout conversation. Change status, assignee, tags, subject, or other fields. |
helpscout.helpscout_list_customers | Read | first_name, last_name, email, page, per_page, sort_field, sort_order, query | List or search customers in HelpScout. Supports filtering by name, email, and pagination. |
helpscout.helpscout_get_customer | Read | id | Get full details of a specific HelpScout customer, including contact info, social profiles, and custom fields. |
helpscout.helpscout_create_customer | Write | first_name, last_name, email, organization, job_title, phone | Create a new customer in HelpScout. Provide at least a name or email address. |
helpscout.helpscout_list_mailboxes | Read | page, per_page | List all mailboxes in HelpScout. Returns mailbox IDs, names, and email addresses. Use mailbox IDs when creating or filtering conversations. |
helpscout.helpscout_get_mailbox | Read | id | Get details of a specific HelpScout mailbox, including name, email, folders, and user assignments. |
helpscout.helpscout_get_current_user | Read | none | Get the profile of the currently authenticated HelpScout user. Useful for verifying API connectivity and identifying the active 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.