Freshdesk
Instead of following these steps manually, you can use the AI Credential Assistant — describe what you want to connect and the AI will walk you through the setup step by step, tailored to your account.
Overview
Connect your Freshdesk account to Nirvai to manage tickets, contacts, and customer support workflows programmatically.
Supported Authentication Methods
- API Key - Recommended (requires subdomain)
Prerequisites
- A Freshdesk account with admin access
- Your Freshdesk subdomain (from
your-company.freshdesk.com)
Setup Instructions
Getting Your API Key
- Log in to your Freshdesk account
- Click your profile picture (top-right)
- Go to Profile Settings
- On the right side, find your API Key
- Copy the API key
- In Nirvai, create a new Freshdesk credential:
- Subdomain: Your Freshdesk subdomain (e.g.,
mycompany) - API Key: The key you copied
- Subdomain: Your Freshdesk subdomain (e.g.,
Finding Your Subdomain
Your subdomain is the first part of your Freshdesk URL:
https://mycompany.freshdesk.com
^^^^^^^^
This is your subdomain
How Authentication Works
Freshdesk API uses Basic Auth with your API key as the username and X as the password:
Username: your_api_key
Password: X
This is handled automatically by Nirvai when you provide the subdomain and API key.
Troubleshooting
Common Issues
- 401 Unauthorized: Check that your API key is correct and hasn't been regenerated.
- 403 Forbidden: Your account role may not have permission for the requested action.
- Wrong subdomain: Verify your Freshdesk URL and enter only the subdomain part.
- 404 Not Found: Resource doesn't exist or you don't have access.
Regenerating Your API Key
If your API key is compromised:
- Go to Profile Settings
- Click Regenerate API Key
- Update your integrations with the new key
- The old key is immediately invalidated
Role-Based Permissions
API access is limited by your Freshdesk role:
| Role | Access Level |
|---|---|
| Admin | Full API access |
| Agent | Limited to assigned tickets |
| Supervisor | Team-level access |
API Rate Limits
Freshdesk enforces rate limits based on your plan:
| Plan | Rate Limit |
|---|---|
| Sprout/Blossom | 50 requests/minute |
| Garden | 200 requests/minute |
| Estate | 400 requests/minute |
| Forest | 700 requests/minute |
Responses include X-RateLimit-* headers.
Security Best Practices
- Keep your API key confidential
- Don't commit keys to version control
- Regenerate keys if you suspect compromise
- Consider creating a dedicated agent account for API access
Related Resources
Adapted for Nirvai platform
Next Steps
Use the AI Tool Creator to turn this credential into agent-callable tools. Describe what your agent should be able to do and the AI investigates the API, configures the endpoints, and gives you a reviewable toolkit before saving anything.