About Freshsales
Iru reads users with their roles, roles with permissions, territories, and field-level permissions for sensitive data from the Freshsales (Freshworks CRM) API. Authentication uses an API key together with your bundle alias, both found under Profile Settings → API Settings. Requests targethttps://YOUR_BUNDLE_ALIAS.myfreshworks.com/crm/sales/api. The connector wizard collects the API key first, then the bundle alias.
Freshsales and Freshservice are different products with different authentication schemes. If you are connecting IT service management data, use the Freshservice article instead.
How It Works
Authorization header in the literal form Token token=YOUR_API_KEY. The API is unversioned. There is no version header or dated revision.
The bundle alias selects which CRM account to read when your Freshworks organization has more than one. That is why the field is required. An API key is per user and inherits exactly that user’s role, with no per-endpoint scopes.
Official references: Freshworks CRM API.
Prerequisites
- Your bundle alias and API key, both on the same API Settings page.
- A dedicated admin-level CRM user to generate the key from. The key inherits that user’s role and has no scopes, so a key from a sales user with territory restrictions returns an incomplete permission picture.
Connect Freshsales to Iru
- Freshsales
- Iru Compliance
Complete this tab before you connect the source in Compliance.
1
Sign in to Freshsales
Sign in to your Freshsales account as the admin-level user whose access the integration should inherit.
2
Open Profile Settings
Select your profile picture in the top-right corner, then Profile Settings.
3
Open API Settings
Select the API Settings tab.
4
Copy the API key and bundle alias
Copy the value shown under Your API key. Copy the Bundle alias, shown on the same tab just below the API key. If your organization has only one CRM account this is still required.
Continue on the Iru Compliance tab.
Troubleshooting
Nothing opens when you turn the source on
Nothing opens when you turn the source on
Check pop-up blocker settings for the Iru site and try again.
401 Authentication Failure
401 Authentication Failure
Confirm the API key is complete and that the bundle alias matches the CRM account the key belongs to. A valid key against the wrong bundle host fails the same way an invalid key does.
You copied a Freshservice key by mistake
You copied a Freshservice key by mistake
The two products issue different credentials and authenticate differently. A Freshservice key will not work here.
Users appear but roles or territories are incomplete
Users appear but roles or territories are incomplete
The key belongs to a user whose own role cannot see them. Regenerate from an admin-level user.
The wizard reports an unreachable host
The wizard reports an unreachable host
The bundle alias is the subdomain only. Do not include
https:// or .myfreshworks.com.Related Articles
Sources Management
Browse and manage every Compliance source.
Freshservice
Connect Freshservice for ITSM evidence.
Getting Started With Compliance
Frameworks, actions, and Artifacts.
Artifacts Management
Upload, review, and organize evidence from sources and actions.