# Helpdesk

HelpDesk is a ticketing system designed to streamline customer support by organizing and managing inquiries efficiently.

- **Category:** customer support
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 14
- **Triggers:** 0
- **Slug:** `HELPDESK`
- **Version:** 20260313_00

## Tools

### List Agents

**Slug:** `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 - 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

| Parameter | 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 or not |

### List Canned Responses

**Slug:** `HELPDESK_LIST_CANNED_RESPONSES`

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

#### Output

| Parameter | 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 or not |

### List Custom Fields

**Slug:** `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

| Parameter | 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 or not |

### List Email Domains

**Slug:** `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 HelpDesk 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 - Audit which domains are actively being used for inbox No parameters required - returns all email domains accessible to the authenticated account.

#### Output

| Parameter | 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 or not |

### List Licenses

**Slug:** `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 - Inspect company settings and feature flags No parameters required - returns all licenses for the authenticated account.

#### Output

| Parameter | 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 or not |

### List Reply Addresses

**Slug:** `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 - Audit reply address configuration across the account No parameters required - returns all reply addresses accessible to the authenticated account.

#### Output

| Parameter | 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 or not |

### List Rules

**Slug:** `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

| Parameter | 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 or not |

### List Subscriptions

**Slug:** `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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string ("active" | "expired" | "canceled" | "future" | "pending") | 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

| Parameter | 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 or not |

### List Teams

**Slug:** `HELPDESK_LIST_TEAMS`

Lists all teams in the HelpDesk account. Returns a comprehensive list of all teams configured in the HelpDesk 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 - View team integration configurations No parameters required - returns all teams accessible to the authenticated account.

#### Output

| Parameter | 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 or not |

### List Tickets

**Slug:** `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) - Multiple sort options (createdAt, updatedAt, lastMessageAt) in ascending or descending order Common use cases: - Get all open tickets: Use default parameters with silo='tickets' - Browse archived tickets: Set silo='archive' - Paginate through results: Use next_value and next_id from previous response

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `silo` | string ("tickets" | "archive" | "trash" | "spam") | No | Silo/folder to list tickets from. Defaults to 'tickets'. |
| `order` | string ("asc" | "desc") | No | Sort direction (asc or desc). |
| `sortBy` | string ("createdAt" | "updatedAt" | "lastMessageAt") | No | Field to sort by. |
| `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

| Parameter | 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 or not |

### List Trusted Emails

**Slug:** `HELPDESK_LIST_TRUSTED_EMAILS`

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

#### Output

| Parameter | 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 or not |

### List Views

**Slug:** `HELPDESK_LIST_VIEWS`

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

#### Output

| Parameter | 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 or not |

### List Webhooks

**Slug:** `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

| Parameter | 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 or not |

### View Agent

**Slug:** `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 list_agents action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agentID` | string | Yes | The unique identifier (UUID format) of the agent to retrieve. Obtain agent IDs from the list_agents action. |

#### Output

| Parameter | 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 or not |