Skip to content


Freshservice on Hire2Retire supports API Key Authentication

An API key serves as a security token, facilitating authentication and authorization to access and interact with the SCIM API offered by the Freshservice. Freshservice provides a number of ways to interact with a Freshservice account for the users. The REST API they provide allows you to add and configure users on a Freshservice account including provisioning and deprovisioning.

We at RoboMQ pay utmost attention to keep your account secure. See our Security and Privacy Policies to learn more about how RoboMQ handles your account access.

Generate API Key in Freshservice

To perform the provisioning and deprovisioning on Freshservice through Hire2Retire, please ensure that you are taking the API Key of the Administrator account or of the user whose user type is Organization Admin. Admin account should have necessary permissions to manage the users on Freshservice.

Please find the steps to obtain the API Key:

  1. Login to your freshservice account by entering your instance or portal name at Login to Freshservice

  2. Click on your profile picture on the top right corner of your portal.

  3. Go to Profile settings Page.

  4. Your API key will be available below the Delegate Approvals section to your right.
    Freshservice API Key

    Figure 1. API Key on Freshservice Portal

Please copy this API Key and enter on Hire2Retire platform while configuring the connection with Freshservice.

Freshservice API Key Auth

To link your Freshservice account using API Key Authentication, you have to specify your Instance URL and API Key on Hire2Retire platform.

Freshservice API Key Authentication

Figure 2. Authentication Form for Freshservice on RoboMQ Hire2Retire

  1. Instance URL: Instance URL is the unique Freshservice portal address provided by the Freshservice. You can find your instance URL in the URL tab. You only need to enter the instance or portal name on Hire2Retire authentication form. When you visit the website, you can find the Freshservice URL as Here xyz denotes your freshservice instance name. Freshservice Instance URL

    Figure 3. Instance URL for Freshservice

  2. API Key: Please enter the API Key obtained from the Freshservice admin account by following the steps mentioned above.

Once the connection is established successfully, then you can define the roles and mapping on Hire2Retire Provisioning.