# Freshdesk (prebuilt connector)

## Description

**Freshdesk** is a cloud-based customer engagement solution for streamlining customer support.

## API documentation

API documentation for **Freshdesk** (used to build this connector) can be found via the link below:

{% embed url="<https://developers.freshdesk.com/>" %}

## Authentication&#x20;

When adding connector instances for **Freshdesk**, the following authentication methods are supported:

* [API key](#api-key-authentication)

### API key authentication

When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **API key** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th width="145" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>api key</code></td><td>true</td><td>Your API can be accessed via your Freshdesk user profile. For more information please see <a href="https://support.freshdesk.com/en/support/solutions/articles/215517-how-to-find-your-api-key">this Freshdesk guide</a>.</td></tr><tr><td><code>domain</code></td><td>true</td><td>The URL that you use to access Freshdesk will be in the following form: <code>https://domain.freshdesk.com</code>, where 'domain' is unique to your organisation - for example: <code>https://patchworks.freshdesk.com</code>. Enter your domain here - for example: <code>patchworks</code>.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/freshdesk-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.