> ## Documentation Index
> Fetch the complete documentation index at: https://docs.typewise.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Freshdesk

> Connect Freshdesk and use available lookups and actions.

Connect Freshdesk to let the AI retrieve ticket details (lookups) and perform
approved updates (actions).

## On this page

* [Connect](#connect)
* [Supported tools](#supported-tools)
  * [Lookups](#lookups)
  * [Actions](#actions)

## Connect

<Steps>
  <Step title="Get your Freshdesk API key">
    Log in to Freshdesk and retrieve your API key. Refer to [Freshdesk's documentation](https://support.freshdesk.com/support/solutions/articles/215517-how-to-find-your-api-key) for instructions on finding your API key.

    <Note>
      The API key is tied to your user account. All actions performed through the integration will be attributed to this user.
    </Note>
  </Step>

  <Step title="Connect Freshdesk in Typewise">
    In Typewise, go to **Integrations**, find Freshdesk, and click **Connect**. You'll need:

    * **Subdomain:** The first part of your Freshdesk URL. For example, for `https://acme.freshdesk.com`, the subdomain is `acme`.
    * **API Key:** The API key from your Freshdesk account.

    After you click **Install**, Freshdesk should be connected successfully.
  </Step>
</Steps>

## Supported tools

The following is a selection of commonly used tools available through the
Freshdesk integration. Additional lookups and actions are available. Contact us
if you need a tool that isn't listed here.

### Lookups

<AccordionGroup>
  <Accordion title="get_freshdesk_ticket_by_id">
    Retrieve a Freshdesk ticket by its ID, including all ticket fields and metadata.

    | Parameter | Description                       | Required | Default |
    | :-------- | :-------------------------------- | :------: | :------ |
    | `case_id` | The ID of the ticket to retrieve. |    Yes   |         |
  </Accordion>

  <Accordion title="More lookups available">
    Additional Freshdesk lookup tools are available. Contact us to enable lookups not listed here.
  </Accordion>
</AccordionGroup>

### Actions

<AccordionGroup>
  <Accordion title="More actions available">
    Freshdesk action tools are available. Contact us to enable actions for your
    use case.
  </Accordion>
</AccordionGroup>