Skip to main content

​
Freshdesk API Credentials

Freshdesk API credentials allow your SubverseAI agents and orchestrations to interact with your Freshdesk support desk.

​
Overview

Freshdesk credentials provide access to:
  • Ticket management (create, read, update, delete)
  • Ticket notes and replies
  • Agent, group, product, and company lookups
  • Support workflow automation

​
Steps to Create Freshdesk API Credentials

​
1. Access Your Freshdesk Profile

  1. Log in to your Freshdesk account at https://<your-domain>.freshdesk.com
  2. Click your profile icon in the top-right corner
  3. Select Profile Settings

​
2. Copy Your API Key

  1. In the right-hand panel, find your API Key
  2. Click the copy icon to copy it to your clipboard
Treat your API key like a password. Do not share it or commit it to source control.

​
3. Identify Your Domain

Your domain is the subdomain of your Freshdesk URL. For example, if your URL is https://acme.freshdesk.com, your domain is acme.

​
4. Add to SubverseAI

  1. Go to Credentials in your SubverseAI dashboard
  2. Click Create New Credential
  3. Select Freshdesk API from the credential types
  4. Enter a name for your credential
  5. Fill in the required fields:
    • API Key: Your Freshdesk API key
    • Domain: Your Freshdesk subdomain (e.g., acme)
  6. Click Test Connection to verify the credentials work
  7. Click Save Credential

​
Required Fields

  • Name: A descriptive name for your credential
  • API Key: Your Freshdesk API key
  • Domain: Your Freshdesk subdomain (without .freshdesk.com)

​
Usage Tips

  • Use a dedicated API key per integration so you can revoke access independently
  • Ensure the agent whose API key you use has permission to manage tickets
  • The credential supports standard Freshdesk API v2 endpoints

​
Troubleshooting

Invalid Domain: Make sure you enter only the subdomain part. Use acme instead of acme.freshdesk.com. Authentication Failed: Verify that the API key is correct and that the agent account is active. Permission Denied: Check that the agent has the required Freshdesk role permissions for ticket operations.

​
Next Steps

After creating your Freshdesk credentials: