Skip to main content

​
At a glance

  • Availability: Experimental (how to enable).
  • Authentication: Basic auth.
  • Connection: HTTP Basic auth with FRESHDESK_API_KEY as the username and FRESHDESK_API_PASSWORD as the password.
  • Provider documentation: Authentication reference.

​
Credentials

Set these per environment. See Connect an integration.

​
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.

​
Provider notes

  • 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.

​
Tools

​
Verify the connection

Call a read tool such as freshdesk__list_tickets with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.