Freshservice

Last updated on May 30, 2023

Freshservice is a cloud-based IT service management (ITSM) software that helps organizations manage their IT infrastructure and assets. It includes features such as incident management, problem management, change management, and asset management. It also provides a self-service portal for employees to request IT assistance.

You can replicate the data from your Freshservice account to a Destination database or data warehouse using Hevo Pipelines. Refer to section, Data Model for the list of supported objects.

Hevo uses the Freshservice API to replicate the data present in your Freshservice account to the desired Destination database or data warehouse for scalable analysis.

Setup

Data Sync

Prerequisites

An active Freshservice account from which data is to be ingested exists.
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
The API key is available to authenticate Hevo on your Freshservice account.
Freshservice account domain, which is used to access the dashboard, is available. It is usually in the format, <companyname>.freshservice.com, where the domain name is companyname.
You are logged in as an Admin user or have the necessary permissions to access all the data. Read User Types to know about the different types of user accounts and their associated permissions in Freshservice.

Obtaining the API Key

Hevo uses the API key to authenticate itself on your Freshservice account. The API key does not expire and can be reused for all your Pipelines.

Note: You must log in as an Admin user to perform these steps.

Specify the Customer Relationship Management (CRM) Domain Name for your Freshservice account.
In the Sign in page, enter your login credentials, and click Sign in.
Click on your profile picture in the top right corner, and click Profile settings.
In the right pane of the page, select the reCAPTCHA check box to view your API credentials.
Click the Copy icon corresponding to the API key to copy it, and save it securely like any other password. Use this key while configuring your Hevo Pipeline.

Configuring Freshservice as a Source

Perform the following steps to configure Freshservice as the Source in your Pipeline:

Click PIPELINES in the Navigation Bar.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select Freshservice.
In the Configure your Freshservice Source page, specify the following:
- Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
- Domain: The domain identifier for your Freshservice account. For example, in http://westeros.freshservice.com, the domain name is westeros.
- API Key: The API key that you obtained from your Freshservice account.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.

Data Replication

Default Ingestion Frequency	Minimum Ingestion Frequency	Maximum Ingestion Frequency	Custom Frequency Range (Hrs)
1 Hr	1 Hr	24 Hrs	1-24

Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

Historical Data: In the first run of the Pipeline, Hevo ingests all historical data for all the objects and loads it to the Destination.
Incremental Data: Once the historical load is complete, all new and updated records for the Tickets, Problems, Changes, and Releases objects are synchronized with your Destination as per the ingestion frequency.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination database:

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object	Mode	Description
Agents	Full Load	Contains details of all the full-time and occasional users who have access to your Freshservice account. For example, Full-time users are those who regularly log in to your help-desk, such as support engineers. Occasional users are those who only need to log in a few times per month, such as the CEO or field staff.
Agent Group	Full Load	Contains details of the groups into which your agents can be organized to streamline the process of assigning tickets.
Agent Roles	Full Load	Contains details about the access privileges granted to the agents. For example, an admin has access to all aspects, including billing and account administration.
Assets	Full Load	Contains the list of the items owned and managed by the organization, such as laptops and routers.
Asset Types	Full Load	Contains the list of groups into which the assets are classified.
Changes	Incremental	Contains details of the change requests created by users in your Freshservice account.
Contracts	Full Load	Contains details of the deals established between your organization and third-party vendors.
Departments	Full Load	Contains the list of groups created in your Freshservice account to organize different teams and streamline the process of assigning tickets.
Locations	Full Load	Contains details of all the sites where the organization’s assets and users are located.
Problems	Incremental	Contains details of all the incidents reported within your organization.
Products	Full Load	Contains details of the specific models of the assets within an organization. For example, each laptop in an organization is an asset, while the MacBook Pro 2021 model is a product.
Purchase Orders	Full Load	Contains details of the documents issued by a buyer to a seller outlining the types, quantities, and agreed prices for products or services.
Releases	Incremental	Contains details of all the changes to the IT service that are tested and deployed in the live environment.
Requesters	Full Load	Contains details of users who initiate a service request and require support from agents.
Requester Groups	Full Load	Contains the list of user groups that can be assigned specific privileges to access items in the Freshservice account.
Software	Full Load	Contains the list of applications managed across your organization’s network.
Tickets	Incremental	Contains details of the user-reported issues requiring resolution, which can be assigned to agents based on their expertise for resolution.
Vendors	Full Load	Contains details of all the third-party sellers from whom your company purchases any service or product.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Source Considerations

Pagination: An API call for each Freshservice object fetches one page with up to 100 records.
Rate Limit: Freshservice imposes a rate limit based on your plan. Read Rate Limiting to know more about rate limits in Freshservice.

Limitations

Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.
Hevo does not provide you with the option to select the historical sync duration for loading historical data. All the historical data in your Freshservice account is loaded.

Revision History

Refer to the following table for the list of key updates made to this page:

Date	Release	Description of Change
Feb-07-2023	2.07	New document.