Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.
VariableRequiredDescription
FRESHDESK_API_KEYYesFreshdesk API key (used as the HTTP Basic username), from Profile Settings → View API Key Docs.
FRESHDESK_API_PASSWORDNoHTTP Basic password for Freshdesk - leave as the default ‘X’; Freshdesk authenticates with the API key as username and a dummy password Docs.

Setup

  1. 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).
  2. Find your API key: In Freshdesk, click your profile picture → Profile Settings, then reveal ‘Your API Key’ on the right side.
  3. 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.
  4. 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
Provider API reference: https://developers.freshdesk.com/api/

Tools

ToolAccessDescription
List TicketsReadList support tickets in the Freshdesk account
Get TicketReadGet details of a Freshdesk ticket
Create TicketWriteCreate a new support ticket in Freshdesk
Update TicketWriteUpdate fields on an existing Freshdesk ticket
List ContactsReadList 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.