Freshsales is a cloud-based platform that offers sales automation and CRM services to allow you to manage communication with your customers effectively. It provides features such as sales lead tracking, and communication through phone, messages, or emails. It also enables you to gain insights on customer behavior through its analytics and reporting tools.
You can replicate the data from your Freshsales 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 Freshsales API to replicate the data present in your Freshsales account to the desired Destination database or data warehouse for scalable analysis.
Prerequisites
-
An active Freshsales account from which data is to be ingested exists.
-
The API credentials are available to authenticate Hevo on your Freshsales account.
-
You are logged in as an Admin user or have the necessary permissions to access all the data.
-
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
Obtaining the API Credentials
You require the API credentials (API key and bundle alias) to authenticate Hevo on your Freshsales account.
Note: You must log in as an Admin user or a user with Admin access to perform these steps.
Perform the following steps to obtain your API credentials:
-
Log in to your Freshsales account using your CRM Domain Name.
-
On the Sign in page, enter your login credentials and click Sign in.
-
Click your profile picture in the top right corner and click Profile settings.
-
In the top right section of the page that appears, click View API Key.
-
Select the reCAPTCHA check box to view your API credentials.
-
Copy the API key and save it securely like any other password. Use this key as the API token while configuring your Hevo Pipeline.
Configuring Freshsales as a Source
Perform the following steps to configure Freshsales as the Source in your Pipeline:
-
Click PIPELINES in the Navigation Bar.
-
Click + CREATE PIPELINE in the Pipelines List View.
-
On the Select Source Type page, select Freshsales.
-
On the Configure your Freshsales Source page, specify the following:
-
Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
-
API Key: The API key that you obtained from your Freshsales account.
-
Bundle Alias: The bundle alias that you obtained from your Freshsales account.
-
-
Click TEST & CONTINUE.
-
Proceed to configuring the data ingestion and setting up the Destination.
Data Replication
| For Teams Created | Default Ingestion Frequency | Minimum Ingestion Frequency | Maximum Ingestion Frequency | Custom Frequency Range (in Hrs) |
|---|---|---|---|---|
| Before Release 2.21 | 1 Hr | 1 Hr | 24 Hrs | 1-24 |
| After Release 2.21 | 6 Hrs | 30 Mins | 24 Hrs | 1-24 |
Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.
Hevo ingests all the objects in Full Load mode in each run of the Pipeline.
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 | Description |
|---|---|
| Accounts | Contains details of each business that you count as a customer. |
| Accounts View | Contains the list of businesses that you count as customers. |
| Closed Appointments | Contains the list of completed meetings with your prospects. |
| Completed Tasks | Contains the list of the tasks that you have marked as completed. |
| Contacts | Contains details about the people you have interacted with as a part of your business. |
| Contacts View | Contains the list of people that you have interacted with as a part of your business. |
| Deals | Contains details of the business transactions associated with an account. |
| Deals View | Contains the list of business transactions associated with an account. |
| Open Appointments | Contains the list of upcoming meetings with your prospects. |
| Open Tasks | Contains the list of your ongoing tasks. |
| Sales Activities | Contains details of the activities relating to a lead, contact, deal, or account. |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Source Considerations
-
Pagination: An API call for each Freshsales object fetches one page with up to 25 records.
-
Rate Limit: Freshsales imposes a limit of 1000 API calls per hour per account. If the limit is exceeded, Hevo defers the ingestion till the limits reset.
Limitations
-
Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.
-
Hevo does not load an Event into the Destination table if its size exceeds 128 MB, which may lead to discrepancies between your Source and Destination data. To avoid such a scenario, ensure that each row in your Source objects contains less than 100 MB of data.
Revision History
Refer to the following table for the list of key updates made to this page:
| Date | Release | Description of Change |
|---|---|---|
| Jan-07-2025 | NA | Updated the Limitations section to add information on Event size. |
| Nov-05-2024 | NA | Updated section, Obtaining the API Credentials as per the latest Freshsales UI. |
| Mar-05-2024 | 2.21 | Updated the ingestion frequency table in the Data Replication section. |
| Jan-23-2023 | 2.06 | New document. |