Helpdesk

Overview

HelpDesk is a ticketing system designed to streamline customer support by organizing and managing inquiries efficiently. With the integration in SquadOS, your agents can list tickets, agents, teams, automation rules, and account settings, as well as monitor subscriptions and webhooks without leaving the agent workflow.

• Official website: https://www.helpdesk.com/
• Composio documentation: docs.composio.dev/toolkits/helpdesk

Authentication

This tool uses API key (API_KEY) to connect.

You will need the following fields:

Field	Required	Description
api_key	Yes	Personal Access Token (PAT) generated in the LiveChat/HelpDesk Developers Console.

How to get credentials

1. Go to the Developers Console using your HelpDesk credentials.
2. In the side menu, navigate to Tools → Personal Access Tokens.
3. Click Create new token, select the accounts--my:ro scope (minimum required) plus any additional scopes you need, and confirm.
4. Copy the generated token — it is only shown once.
5. Also note your Account ID, displayed at the top of the Console screen; it is required alongside the token for Basic authentication.

Tip

Personal Access Tokens are intended for development and testing. For production use, consider the OAuth 2 Authorization Code Grant flow documented at api.helpdesk.com/docs.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Helpdesk.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the credentials obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)

Available actions

List Agents

HELPDESK_LIST_AGENTS

Retrieves all support agents (team members) in the HelpDesk account. Use this action to get a complete list of agents with their details including: agent profiles (name, email, avatar, job title), role assignments (owner, normal, viewer), team memberships, status (active or invited), auto-assignment settings, and email signatures. This action requires no parameters and returns all agents in the account. Useful for finding agent IDs, checking team composition, or verifying permissions.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Canned Responses

HELPDESK_LIST_CANNED_RESPONSES

Tool to list canned responses. Use when you need to retrieve all predefined reply templates for tickets.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Custom Fields

HELPDESK_LIST_CUSTOM_FIELDS

Tool to list all custom fields defined in the account. Use when you need to view or manage custom fields. Only callable after authentication.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Email Domains

HELPDESK_LIST_EMAIL_DOMAINS

Lists all email domains configured for the HelpDesk account. Returns a comprehensive list of all email domains set up in the account, including domain names, verification status, DNS records, and configuration flags. Email domains allow you to send and receive tickets via custom email addresses. Use this action to: get domain IDs and names for use in other API operations, check domain verification and setup status, view DNS configuration requirements, and audit which domains are actively being used for inbox. No parameters required — returns all email domains accessible to the authenticated account.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Licenses

HELPDESK_LIST_LICENSES

Retrieves all licenses (account configurations) for the authenticated HelpDesk account. A license represents a customer account and contains subscription information, global settings, default team/template assignments, and detected languages. Most accounts have one license. Use this action to: check account configuration and settings, get account ID and metadata, view default team and template assignments, and inspect company settings and feature flags. No parameters required — returns all licenses for the authenticated account.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Reply Addresses

HELPDESK_LIST_REPLY_ADDRESSES

Lists all reply addresses configured in the HelpDesk account. Reply addresses are email addresses used to receive and respond to support tickets. Each reply address must be associated with a verified email domain and can be used as the “From” address when sending ticket responses to customers. Use this action to: get all available reply addresses and their verification status, retrieve reply address IDs for use in other operations (e.g., creating mailboxes), check which email domains are being used for reply addresses, and audit reply address configuration across the account. No parameters required — returns all reply addresses accessible to the authenticated account.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Rules

HELPDESK_LIST_RULES

Tool to retrieve a list of rules configured in the account. Use after authentication when you need an overview of all automation rules.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Subscriptions

HELPDESK_LIST_SUBSCRIPTIONS

Lists all billing subscriptions for the HelpDesk account, including active, expired, canceled, and future subscriptions. Subscriptions represent the currently selected plan (team or enterprise) and number of paid agent slots. Use this tool to retrieve subscription details including plan codes, pricing, billing cycles, trial periods, and subscription states. Both filter parameters are optional — omit them to retrieve all subscriptions.

Input parameters

Name	Type	Required	Description
state	string	No	Optional: Filter by subscription status. Options: active (currently in use), expired (past end date), canceled (manually terminated), future (not yet started), pending (awaiting activation). Omit to include all states.
plan_codes	array	No	Optional: Filter by specific plan codes. Plan naming: hd-{tier}{duration}m where tier is team or enterprise, duration is billing period in months (1, 3, 6, 12, 24, or 36). Examples: hd-team12m (Team plan, 12 months), hd-enterprise6m (Enterprise plan, 6 months). Omit to include all plan types.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Teams

HELPDESK_LIST_TEAMS

Lists all teams in the HelpDesk account. Returns a comprehensive list of all teams configured in the account, including team IDs, names, settings, reply addresses, and integration configurations. Teams are organizational units that group agents and manage ticket routing. Use this action to: get team IDs for use in other API operations, retrieve team names and configurations, audit team settings and reply addresses, and view team integration configurations. No parameters required — returns all teams accessible to the authenticated account.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Tickets

HELPDESK_LIST_TICKETS

List all tickets from a specified silo with cursor-based pagination support. This tool retrieves tickets from the helpdesk system with flexible sorting and pagination. Use this when you need to retrieve tickets for monitoring, reporting, or processing. Key features: retrieves tickets from specified silo (tickets, archive, trash, or spam), supports cursor-based pagination for efficient navigation through large datasets, configurable page size (1–100 tickets per page), and multiple sort options (createdAt, updatedAt, lastMessageAt) in ascending or descending order. Common use cases: get all open tickets using default parameters with silo=tickets; browse archived tickets with silo=archive; paginate through results using next_value and next_id from the previous response.

Input parameters

Name	Type	Required	Description
silo	string	No	Silo/folder to list tickets from. Defaults to tickets.
order	string	No	Sort direction (asc or desc).
sortBy	string	No	Field to sort by (createdAt, updatedAt, or lastMessageAt).
next.ID	string	No	ID of last item on current page (forward cursor).
prev.ID	string	No	ID of first item on current page (backward cursor).
pageSize	integer	No	Number of results per page (1–100).
next.value	string	No	Timestamp of last item on current page (forward cursor).
prev.value	string	No	Timestamp of first item on current page (backward cursor).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Trusted Emails

HELPDESK_LIST_TRUSTED_EMAILS

Tool to retrieve a list of trusted email addresses or domains. Use when managing your spam whitelist after authenticating.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Views

HELPDESK_LIST_VIEWS

Tool to list agent views. Use when you need to retrieve saved ticket views after authentication.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Webhooks

HELPDESK_LIST_WEBHOOKS

Lists all configured webhooks for the HelpDesk account. Webhooks allow you to receive real-time notifications about ticket events (creation, updates, status changes, assignments, etc.) sent as HTTP POST requests to your specified URLs. Use this action to view all active webhook configurations.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

View Agent

HELPDESK_VIEW_AGENT

Retrieves comprehensive details for a specific agent in the HelpDesk system. Returns complete agent information including profile details, role assignments, team memberships, status, settings, and signature configuration. Use this action when you need detailed information about a specific agent after obtaining their ID from the HELPDESK_LIST_AGENTS action.

Input parameters

Name	Type	Required	Description
agentID	string	Yes	The unique identifier (UUID format) of the agent to retrieve. Obtain agent IDs from the HELPDESK_LIST_AGENTS action.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.