> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/helpdesk.md).

# HelpDesk

Create, find, update, and reply to HelpDesk support tickets.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication   |
| --------- | ---------------- |
| HelpDesk  | API key or token |

#### HelpDesk

Connect to HelpDesk tickets with your Text Account ID and personal access token.

**Set up in HelpDesk**

1. Prepare the HelpDesk account or service that the workflow will access. Grant access to the required resources and operations.
2. **Personal access token:** Create a HelpDesk personal access token with the accounts--my:ro scope.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **HelpDesk**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field         | Required | What to enter                                                                                                                                                         |
| --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Account ID            | Yes      | Your Text Account ID used as the Basic-auth username for HelpDesk.                                                                                                    |
| Personal access token | Yes      | Create a HelpDesk personal access token with the accounts--my:ro scope. [Provider instructions](https://platform.text.com/docs/authorization/personal-access-tokens). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **HelpDesk** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Ticket

Create a HelpDesk ticket with an initial plain-text message.

**Required permissions:** `accounts--my:ro`.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                  |
| --------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Requester email | string          | Yes      | Email address of the person requesting support.                                                                              |
| Requester name  | string          | No       | Name shown for the requester.                                                                                                |
| Message         | textarea        | Yes      | Plain-text description of the support request.                                                                               |
| Subject         | string          | No       | Short summary shown in the ticket list.                                                                                      |
| Priority        | select (string) | No       | How urgently the ticket should be handled. Available values: Low (-10), Medium (0), High (10), Urgent (20). Default: medium. |
| Private message | boolean         | No       | Make the initial message visible only to support staff. Default: false.                                                      |

**Outputs**

| Field  | Type   | Description                        |
| ------ | ------ | ---------------------------------- |
| Ticket | object | The newly created HelpDesk ticket. |

#### Add Message to Ticket

Add a public reply or private internal note to a HelpDesk ticket.

**Required permissions:** `accounts--my:ro`.

**Inputs**

| Field                 | Type            | Required | Description                                                                        |
| --------------------- | --------------- | -------- | ---------------------------------------------------------------------------------- |
| Ticket ID             | select (string) | Yes      | HelpDesk ticket to receive the message. Options load from the selected connection. |
| Message               | textarea        | Yes      | Plain-text reply or note to add.                                                   |
| Private internal note | boolean         | No       | Hide this message from the requester. Default: false.                              |

**Outputs**

| Field  | Type   | Description                  |
| ------ | ------ | ---------------------------- |
| Ticket | object | The updated HelpDesk ticket. |

#### Update Ticket

Update safe, reversible HelpDesk ticket metadata.

**Required permissions:** `accounts--my:ro`.

**Inputs**

| Field     | Type            | Required | Description                                                                                   |
| --------- | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Ticket ID | select (string) | Yes      | HelpDesk ticket to update. Options load from the selected connection.                         |
| Subject   | string          | No       | Replacement subject for the ticket.                                                           |
| Status    | select (string) | No       | New workflow status for the ticket. Available values: Open, Pending, On hold, Solved, Closed. |
| Priority  | select (string) | No       | New urgency for the ticket. Available values: Low, Medium, High, Urgent.                      |

**Outputs**

| Field  | Type   | Description                           |
| ------ | ------ | ------------------------------------- |
| Ticket | object | The updated HelpDesk ticket metadata. |

#### List Tickets

Find HelpDesk tickets with bounded cursor pagination.

**Required permissions:** `accounts--my:ro`.

**Inputs**

| Field                 | Type            | Required | Description                                                                                                                            |
| --------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Search text           | string          | No       | Words to search for across tickets.                                                                                                    |
| Status                | select (string) | No       | Return tickets in this workflow status. Available values: Open, Pending, On hold, Solved, Closed. Default: open.                       |
| Subject               | string          | No       | Return tickets matching this subject filter.                                                                                           |
| Show advanced filters | boolean         | No       | Show date, sorting, and continuation options. Default: false.                                                                          |
| Created from          | datetime        | No       | Earliest ticket creation time to include.                                                                                              |
| Created before        | datetime        | No       | Exclusive ticket creation time limit.                                                                                                  |
| Updated from          | datetime        | No       | Earliest ticket update time to include.                                                                                                |
| Updated before        | datetime        | No       | Exclusive ticket update time limit.                                                                                                    |
| Sort by               | select (string) | No       | Ticket timestamp used for sorting and pagination. Available values: Created time, Updated time, Last message time. Default: createdAt. |
| Order                 | select (string) | No       | Direction used to sort tickets. Available values: Newest first, Oldest first. Default: desc.                                           |
| Maximum tickets       | integer         | No       | Maximum number of matching tickets to return. Minimum: 1. Maximum: 1000. Default: 100.                                                 |
| Cursor                | string          | No       | Continue from a previous List Tickets result.                                                                                          |

**Outputs**

| Field       | Type          | Description                                                     |
| ----------- | ------------- | --------------------------------------------------------------- |
| Tickets     | object\_array | Matching HelpDesk tickets.                                      |
| Next cursor | string        | Cursor for the next matching page, when more tickets may exist. |

#### Get Ticket

Retrieve one HelpDesk ticket and its event history.

**Required permissions:** `accounts--my:ro`.

**Inputs**

| Field     | Type            | Required | Description                                                             |
| --------- | --------------- | -------- | ----------------------------------------------------------------------- |
| Ticket ID | select (string) | Yes      | HelpDesk ticket to retrieve. Options load from the selected connection. |

**Outputs**

| Field  | Type   | Description                                          |
| ------ | ------ | ---------------------------------------------------- |
| Ticket | object | The requested HelpDesk ticket and its event history. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/helpdesk.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
