> 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/deskpro.md).

# Deskpro

Create and manage Deskpro support tickets, people, and public replies.

### Connectors

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

| Connector | Authentication |
| --------- | -------------- |
| Deskpro   | API Key        |

#### Deskpro

Connect to Deskpro ticketing with a Personal API v2 key.

**Set up in Deskpro**

1. Prepare the Deskpro account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create an API v2 key in Deskpro under Admin > Apps & Integrations > API Keys. Use Personal or another user context with the permissions needed for the selected actions. For initial setup and testing, set API Tags to '\*' and leave Disallow Tags blank. After setup, replace '\*' with the least-privilege action tags plus 'authentication.me.me' for connection health and account lookup. Resource pickers additionally use 'people.people.list', 'tickets.tickets.list', and 'tickets.ticket\_departments.list'. Status pickers use 'tickets.ticket\_statuses.list'; expression or text inputs remain available when a picker is not permitted. Then revoke any temporary test keys. A Machine Key is not required.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Deskpro**.
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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Deskpro Helpdesk URL | Yes      | Your customer-facing Deskpro helpdesk HTTPS URL, without an /api/v2 suffix.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| API Key              | Yes      | Create an API v2 key in Deskpro under Admin > Apps & Integrations > API Keys. Use Personal or another user context with the permissions needed for the selected actions. For initial setup and testing, set API Tags to '\*' and leave Disallow Tags blank. After setup, replace '\*' with the least-privilege action tags plus 'authentication.me.me' for connection health and account lookup. Resource pickers additionally use 'people.people.list', 'tickets.tickets.list', and 'tickets.ticket\_departments.list'. Status pickers use 'tickets.ticket\_statuses.list'; expression or text inputs remain available when a picker is not permitted. Then revoke any temporary test keys. A Machine Key is not required. [Provider instructions](https://deskpro.gitbook.io/dev-guide/api-basics/auth/api-keys). |

#### 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 **Deskpro** 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

#### List Ticket Departments

Find Deskpro departments that can receive tickets.

**Required permissions:** `tickets.ticket_departments.list`.

**Inputs**

| Field               | Type    | Required | Description                                                                     |
| ------------------- | ------- | -------- | ------------------------------------------------------------------------------- |
| Maximum Departments | integer | No       | Maximum number of departments to return. Minimum: 1. Maximum: 500. Default: 50. |
| Start Page          | integer | No       | Page to start listing from. Minimum: 1. Default: 1.                             |

**Outputs**

| Field       | Type          | Description                                      |
| ----------- | ------------- | ------------------------------------------------ |
| Departments | object\_array | Ticket-enabled departments available in Deskpro. |
| Next Page   | integer       | Next page when more departments are available.   |

#### Create Person

Create a Deskpro customer record.

**Required permissions:** `people.people.post`.

**Inputs**

| Field         | Type   | Required | Description                       |
| ------------- | ------ | -------- | --------------------------------- |
| First Name    | string | Yes      | Customer's first name.            |
| Last Name     | string | Yes      | Customer's last name.             |
| Primary Email | string | Yes      | Customer's primary email address. |

**Outputs**

| Field  | Type   | Description                 |
| ------ | ------ | --------------------------- |
| Person | object | The created Deskpro person. |

#### Get Person

Retrieve a Deskpro customer by ID.

**Required permissions:** `people.people.get`.

**Inputs**

| Field     | Type             | Required | Description                                                                  |
| --------- | ---------------- | -------- | ---------------------------------------------------------------------------- |
| Person ID | select (integer) | Yes      | Numeric ID of the Deskpro person. Options load from the selected connection. |

**Outputs**

| Field  | Type   | Description                  |
| ------ | ------ | ---------------------------- |
| Person | object | The matching Deskpro person. |

#### Create Ticket

Create a Deskpro support ticket with an initial message.

**Required permissions:** `tickets.tickets.post`.

**Inputs**

| Field           | Type             | Required | Description                                                                                   |
| --------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------- |
| Subject         | string           | Yes      | Short summary of the support request.                                                         |
| Initial Message | textarea         | Yes      | Customer's initial support message.                                                           |
| Customer Email  | string           | Yes      | Email address of the customer opening the ticket.                                             |
| Department      | select (integer) | Yes      | Deskpro department that should receive the ticket. Options load from the selected connection. |
| Urgency         | integer          | No       | Optional Deskpro urgency value.                                                               |

**Outputs**

| Field  | Type   | Description                 |
| ------ | ------ | --------------------------- |
| Ticket | object | The created Deskpro ticket. |

#### Get Ticket

Retrieve one Deskpro ticket by ID.

**Required permissions:** `tickets.tickets.get`.

**Inputs**

| Field     | Type             | Required | Description                                                                  |
| --------- | ---------------- | -------- | ---------------------------------------------------------------------------- |
| Ticket ID | select (integer) | Yes      | Numeric ID of the Deskpro ticket. Options load from the selected connection. |

**Outputs**

| Field  | Type   | Description                  |
| ------ | ------ | ---------------------------- |
| Ticket | object | The matching Deskpro ticket. |

#### List Tickets

List and filter Deskpro tickets.

**Required permissions:** `tickets.tickets.list`.

**Inputs**

| Field           | Type             | Required | Description                                                                      |
| --------------- | ---------------- | -------- | -------------------------------------------------------------------------------- |
| Status          | select (string)  | No       | Only return tickets with this status. Options load from the selected connection. |
| Customer        | select (integer) | No       | Only return tickets for this customer.                                           |
| Department      | select (integer) | No       | Only return tickets in this department.                                          |
| Maximum Tickets | integer          | No       | Maximum number of tickets to return. Minimum: 1. Maximum: 500. Default: 100.     |
| Start Page      | integer          | No       | Page to start listing from. Minimum: 1. Default: 1.                              |

**Outputs**

| Field     | Type          | Description                                |
| --------- | ------------- | ------------------------------------------ |
| Tickets   | object\_array | Typed Deskpro ticket summaries.            |
| Next Page | integer       | Next page when more tickets are available. |

#### Update Ticket

Change common fields on an existing Deskpro ticket.

**Required permissions:** `tickets.tickets.put`.

**Inputs**

| Field     | Type             | Required | Description                                                                            |
| --------- | ---------------- | -------- | -------------------------------------------------------------------------------------- |
| Ticket ID | select (integer) | Yes      | Numeric ID of the Deskpro ticket to update. Options load from the selected connection. |
| Subject   | string           | No       | New ticket subject.                                                                    |
| Status    | select (string)  | No       | New ticket status. Options load from the selected connection.                          |
| Urgency   | integer          | No       | New Deskpro urgency value.                                                             |

**Outputs**

| Field          | Type   | Description                  |
| -------------- | ------ | ---------------------------- |
| Updated Ticket | object | The ticket after the update. |

#### Add Ticket Reply

Add a public reply to a Deskpro ticket.

**Required permissions:** `tickets.ticket_messages.post`.

**Inputs**

| Field     | Type             | Required | Description                                                                  |
| --------- | ---------------- | -------- | ---------------------------------------------------------------------------- |
| Ticket ID | select (integer) | Yes      | Numeric ID of the Deskpro ticket. Options load from the selected connection. |
| Reply     | textarea         | Yes      | Public reply to add to the ticket.                                           |

**Outputs**

| Field          | Type   | Description                        |
| -------------- | ------ | ---------------------------------- |
| Ticket Message | object | The created public ticket message. |

#### List Ticket Messages

List messages on a Deskpro ticket.

**Required permissions:** `tickets.ticket_messages.list`.

**Inputs**

| Field            | Type             | Required | Description                                                                   |
| ---------------- | ---------------- | -------- | ----------------------------------------------------------------------------- |
| Ticket ID        | select (integer) | Yes      | Numeric ID of the Deskpro ticket. Options load from the selected connection.  |
| Maximum Messages | integer          | No       | Maximum number of messages to return. Minimum: 1. Maximum: 500. Default: 100. |
| Start Page       | integer          | No       | Page to start listing from. Minimum: 1. Default: 1.                           |

**Outputs**

| Field     | Type          | Description                                  |
| --------- | ------------- | -------------------------------------------- |
| Messages  | object\_array | Typed messages from the ticket conversation. |
| Next Page | integer       | Next page when more messages are available.  |

### 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/deskpro.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.
