At a glance
- Availability: Experimental (how to enable).
- Auth: Basic auth.
- Connection: HTTP Basic auth with
FRESHDESK_API_KEYas the username andFRESHDESK_API_PASSWORDas the password. - Docs: https://developers.freshdesk.com/api/#authentication
Credentials
Set these per environment. See Connect an integration.| Variable | Required | Description |
|---|---|---|
FRESHDESK_API_KEY | Yes | Freshdesk API key (used as the HTTP Basic username), from Profile Settings → View API Key Docs. |
FRESHDESK_API_PASSWORD | No | HTTP Basic password for Freshdesk - leave as the default ‘X’; Freshdesk authenticates with the API key as username and a dummy password Docs. |
Setup
- Create a Freshdesk account: Sign up at https://www.freshdesk.com/ - the free plan or a trial works for testing. Note your subdomain (yourcompany in yourcompany.freshdesk.com).
- Find your API key: In Freshdesk, click your profile picture → Profile Settings, then reveal ‘Your API Key’ on the right side.
- Set environment variables: Add FRESHDESK_API_KEY to your .env. Leave FRESHDESK_API_PASSWORD unset (it defaults to ‘X’) - Freshdesk uses HTTP Basic auth with the API key as the username and a dummy password.
- Verify access: Run the List Tickets tool with your subdomain as the domain parameter.
- Freshdesk does not use OAuth for its REST API; HTTP Basic with the personal API key is the official method
- The API key inherits the permissions of the agent it belongs to
- All endpoints are per-account: https://<domain>.freshdesk.com/api/v2, HTTPS only
Tools
| Tool | Access | Description |
|---|---|---|
| List Tickets | Read | List support tickets in the Freshdesk account |
| Get Ticket | Read | Get details of a Freshdesk ticket |
| Create Ticket | Write | Create a new support ticket in Freshdesk |
| Update Ticket | Write | Update fields on an existing Freshdesk ticket |
| List Contacts | Read | List contacts in the Freshdesk account |
Example prompts
- List my open Freshdesk tickets with their priorities and due dates.
- Create a new Freshdesk ticket with a subject, description, and requester email.