Freshdesk
API keyCommunication & SupportOrg connection
Org-level connection
Freshdesk is connected once at the org level by an admin. The credential is shared across all groups that have been granted access — individual team members don't need to connect their own accounts.
Getting your API key
Enter your Freshdesk subdomain in the field above (e.g. mycompany from mycompany.freshdesk.com)
Log in to Freshdesk, click your avatar (top-right) → Profile Settings
Your API key is shown in the right panel under "Your API Key"
Copy it and paste it below
Ready to connect?
Sign in to On Belay and open the Integrations page to add Freshdesk.
Permissions (scopes)
These are the data scopes On Belay can be granted for Freshdesk. Your org admin controls which scopes are enabled per group.
| Scope | Description | Access |
|---|---|---|
tickets:read | Read tickets | Read only |
tickets:write | Write tickets | Read / Write |
contacts:read | Read contacts | Read only |
agents:read | Read agents | Read only |
reports:read | Read reports | Read only |
Troubleshooting
"Invalid API key" or "Unauthorized" error
Double-check that you copied the full key without any leading/trailing spaces. Some platforms show a truncated preview — make sure to copy the full token. If the key was generated with restricted scopes, verify it includes the permissions listed above.
Connected but Claude can't access data
Check that your group has been granted access to this integration in On Belay → Groups → [your group] → Integrations. Also verify the specific scopes your group is permitted to use match what your query requires.
The key expires or stops working
Some API keys have expiration policies. Generate a new key in Freshdesk and update it in On Belay → Integrations → Freshdesk → Update key. Consider creating a dedicated service account or machine user for On Belay so the key isn't tied to a personal account.
Still stuck? We're happy to help.
Contact support →