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

# Freshdesk

Create and manage support tickets in Freshdesk, the customer support and helpdesk platform.

### Connectors

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

| Connector | Authentication |
| --------- | -------------- |
| Freshdesk | Credentials    |

#### Freshdesk

Connect to Freshdesk with an API key to create and manage support tickets.

**Set up in Freshdesk**

1. Prepare the Freshdesk account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Your Freshdesk API key, found under Profile Settings > API Key.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Freshdesk**.
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                                                                                                                                             |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Domain        | Yes      | Your Freshdesk subdomain, the part before '.freshdesk.com' in your helpdesk URL (e.g. 'stackai' for stackai.freshdesk.com).                               |
| API Key       | Yes      | Your Freshdesk API key, found under Profile Settings > API Key. [Provider instructions](https://support.freshdesk.com/support/solutions/articles/215517). |

#### 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 **Freshdesk** 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 new support ticket in Freshdesk.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                                                       |
| --------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Subject         | string          | Yes      | Title of the ticket.                                                                                                                                              |
| Description     | textarea        | Yes      | Body of the ticket. HTML is allowed and renders in Freshdesk.                                                                                                     |
| Requester Email | string          | Yes      | Email address of the person requesting support.                                                                                                                   |
| Priority        | select (string) | No       | Ticket priority. Defaults to Medium. Available values: Low, Medium, High, Urgent. Default: medium.                                                                |
| Status          | select (string) | No       | Initial ticket status. Defaults to Open. Available values: Open, Pending, Resolved, Closed. Default: open.                                                        |
| Source          | select (string) | No       | Channel the ticket originated from. Defaults to Portal. Available values: Email, Portal, Phone, Chat, Mobihelp, Feedback Widget, Outbound Email. Default: portal. |
| Tags            | string          | No       | Comma-separated tags to apply to the ticket.                                                                                                                      |
| Type            | string          | No       | Ticket category, e.g. Question, Problem, Incident.                                                                                                                |

**Outputs**

| Field          | Type    | Description                                                        |
| -------------- | ------- | ------------------------------------------------------------------ |
| Ticket ID      | integer | Unique ID of the created ticket, for downstream nodes.             |
| Subject        | string  | Subject of the created ticket.                                     |
| Status Code    | integer | Numeric status code of the created ticket.                         |
| Status         | string  | Human-readable status of the created ticket.                       |
| Priority Code  | integer | Numeric priority code of the created ticket.                       |
| Priority       | string  | Human-readable priority of the created ticket.                     |
| Source Code    | integer | Numeric source/channel code of the created ticket.                 |
| Requester ID   | integer | ID of the contact Freshdesk resolved or created for the requester. |
| Created At     | string  | Timestamp the ticket was created.                                  |
| Due By         | string  | Resolution deadline for the ticket, if set.                        |
| Result Message | string  | Human-readable result summary.                                     |

#### List Tickets

List support tickets in Freshdesk with pagination and filters.

**Inputs**

| Field           | Type                      | Required | Description                                                                                                                       |
| --------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| Page            | integer                   | No       | Page number to fetch, starting at 1. Default: 1.                                                                                  |
| Per Page        | integer                   | No       | Tickets per page. Defaults to 50. Default: 50.                                                                                    |
| Order By        | select (string)           | No       | Field to sort tickets by. Defaults to Created At. Available values: Created At, Due By, Updated At, Status. Default: created\_at. |
| Order Direction | select (string)           | No       | Sort direction. Defaults to Descending. Available values: Ascending, Descending. Default: desc.                                   |
| Requester ID    | integer                   | No       | Only return tickets opened by this contact ID.                                                                                    |
| Requester Email | string                    | No       | Only return tickets opened by this email address.                                                                                 |
| Company ID      | integer                   | No       | Only return tickets linked to this company ID.                                                                                    |
| Updated Since   | string                    | No       | Only return tickets updated after this ISO 8601 timestamp.                                                                        |
| Include         | multiple\_select (string) | No       | Related objects to expand inline on each ticket. Available values: Company, Requester, Description, Stats. Default: \[].          |

**Outputs**

| Field          | Type          | Description                                          |
| -------------- | ------------- | ---------------------------------------------------- |
| Tickets        | object\_array | Tickets on the requested page.                       |
| Count          | integer       | Number of tickets returned on this page.             |
| Has More       | boolean       | Whether another page of tickets is likely available. |
| Result Message | string        | Human-readable result summary.                       |

#### Get Ticket

Fetch a single support ticket from Freshdesk by ID.

**Inputs**

| Field     | Type                      | Required | Description                                                                                                                            |
| --------- | ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Ticket ID | integer                   | Yes      | Numeric ID of the ticket to fetch.                                                                                                     |
| Include   | multiple\_select (string) | No       | Related objects to expand inline on the ticket. Available values: Company, Requester, Description, Stats, Conversations. Default: \[]. |

**Outputs**

| Field          | Type    | Description                                            |
| -------------- | ------- | ------------------------------------------------------ |
| Ticket ID      | integer | Unique ID of the fetched ticket, for downstream nodes. |
| Subject        | string  | Subject of the fetched ticket.                         |
| Status Code    | integer | Numeric status code of the ticket.                     |
| Status         | string  | Human-readable status of the ticket.                   |
| Priority Code  | integer | Numeric priority code of the ticket.                   |
| Priority       | string  | Human-readable priority of the ticket.                 |
| Source Code    | integer | Numeric source/channel code of the ticket.             |
| Requester ID   | integer | ID of the contact who opened the ticket.               |
| Created At     | string  | Timestamp the ticket was created.                      |
| Updated At     | string  | Timestamp the ticket was last updated.                 |
| Due By         | string  | Resolution deadline for the ticket, if set.            |
| Result Message | string  | Human-readable result summary.                         |

#### Update Ticket

Update fields on an existing Freshdesk support ticket.

**Inputs**

| Field                 | Type            | Required | Description                                                                   |
| --------------------- | --------------- | -------- | ----------------------------------------------------------------------------- |
| Ticket ID             | integer         | Yes      | Numeric ID of the ticket to update.                                           |
| Subject               | string          | No       | New subject for the ticket.                                                   |
| Description           | textarea        | No       | New body for the ticket. HTML is allowed.                                     |
| Priority              | select (string) | No       | New priority for the ticket. Available values: Low, Medium, High, Urgent.     |
| Status                | select (string) | No       | New status for the ticket. Available values: Open, Pending, Resolved, Closed. |
| Type                  | string          | No       | New ticket category, e.g. Question, Problem, Incident.                        |
| Assigned Agent ID     | integer         | No       | Reassign the ticket to this agent ID.                                         |
| Support Group ID      | integer         | No       | Reassign the ticket to this support group ID.                                 |
| Company ID            | integer         | No       | Link the ticket to this company ID.                                           |
| New Requester Email   | string          | No       | Reassign the ticket to the requester with this email.                         |
| New Requester Phone   | string          | No       | Reassign the ticket to the requester with this phone number.                  |
| New Requester Name    | string          | No       | Name for the new requester (required with phone-only requester).              |
| Tags                  | string          | No       | Comma-separated tags; replaces the ticket's current tags.                     |
| CC Emails             | string          | No       | Comma-separated CC addresses; replaces the ticket's current CC list.          |
| Due By                | string          | No       | New resolve-by deadline, ISO 8601.                                            |
| First Response Due By | string          | No       | New first-response deadline, ISO 8601.                                        |

**Outputs**

| Field          | Type    | Description                                             |
| -------------- | ------- | ------------------------------------------------------- |
| Ticket ID      | integer | Unique ID of the updated ticket, for downstream nodes.  |
| Subject        | string  | Subject of the updated ticket.                          |
| Status Code    | integer | Numeric status code of the ticket after the update.     |
| Status         | string  | Human-readable status of the ticket after the update.   |
| Priority Code  | integer | Numeric priority code of the ticket after the update.   |
| Priority       | string  | Human-readable priority of the ticket after the update. |
| Source Code    | integer | Numeric source/channel code of the ticket.              |
| Requester ID   | integer | ID of the ticket's requester after the update.          |
| Created At     | string  | Timestamp the ticket was created.                       |
| Updated At     | string  | Timestamp the ticket was last updated.                  |
| Due By         | string  | Resolution deadline for the ticket, if set.             |
| Result Message | string  | Human-readable result summary.                          |

#### Create Contact

Create a new contact in Freshdesk.

**Inputs**

| Field                        | Type     | Required | Description                                                |
| ---------------------------- | -------- | -------- | ---------------------------------------------------------- |
| Name                         | string   | No       | Contact's full name.                                       |
| Email                        | string   | No       | Contact's primary email address.                           |
| Phone                        | string   | No       | Contact's phone number.                                    |
| Company ID                   | integer  | No       | Link the contact to this company ID.                       |
| Job Title                    | string   | No       | Contact's job title.                                       |
| Mobile                       | string   | No       | Contact's mobile number.                                   |
| Address                      | string   | No       | Contact's street address.                                  |
| Language                     | string   | No       | Contact's language code. Garden plan and above.            |
| Time Zone                    | string   | No       | Contact's IANA time zone. Garden plan and above.           |
| Twitter Handle               | string   | No       | Contact's Twitter handle.                                  |
| External ID                  | string   | No       | Unique ID for this contact in an external system.          |
| Description                  | textarea | No       | Internal notes about the contact.                          |
| Tags                         | string   | No       | Comma-separated tags to apply to the contact.              |
| Other Emails                 | string   | No       | Comma-separated additional email addresses.                |
| Can View All Company Tickets | boolean  | No       | Allow this contact to view all tickets from their company. |

**Outputs**

| Field          | Type    | Description                                             |
| -------------- | ------- | ------------------------------------------------------- |
| Contact ID     | integer | Unique ID of the created contact, for downstream nodes. |
| Name           | string  | Name of the created contact.                            |
| Email          | string  | Email of the created contact.                           |
| Phone          | string  | Phone number of the created contact.                    |
| Company ID     | integer | Company ID linked to the created contact, if any.       |
| Created At     | string  | Timestamp the contact was created.                      |
| Result Message | string  | Human-readable result summary.                          |

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