Skip to main content

Freshsales Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Freshsales location.
freshsales.png

Freshsales

Follow the instructions below to create a new data flow that ingests data from a Freshsales source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Freshsales connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Freshsales account, and click Next; or, create a new Freshsales credential for use in this flow.

  3. In Nexla, Freshsales data sources can be created using pre-built endpoint templates, which expedite source setup for common Freshsales endpoints. Each template is designed specifically for the corresponding Freshsales endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Freshsales sources can also be configured manually, allowing you to ingest data from Freshsales endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Freshsales endpoints. Each template is designed specifically for the corresponding Freshsales endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List all resources

    List all resources of a given type

    • Enter the resource type you want to fetch in the Resource type field. This should be the type of resource you want to retrieve, such as leads, contacts, deals, accounts, or users. The resource type determines which Freshsales API endpoint will be used to fetch data.
    • Enter the view ID in the View id field. This is the numeric identifier for a specific view or filter in Freshsales that defines which records should be retrieved. The view ID determines which subset of records from the specified resource type will be returned by the API.
    • The endpoint uses GET requests to https://{domain}/api/{resource_type}/view/{view_id} where {domain} is your Freshsales domain and {resource_type} and {view_id} are the values you configured. The endpoint URL is automatically constructed based on your credential configuration and the resource type and view ID you specify.
    • The endpoint uses pagination (iteration.type: paging.incrementing) to retrieve all records. Pagination starts from page 1 and uses the page query parameter to navigate through pages. The per_page parameter controls how many records are returned per page, with a default of 100 records per page. The endpoint will automatically fetch all pages until all records are retrieved.
    • The response data path is $.{resource_type}[*], which extracts all records from the resource type array in the API response. Additional metadata is extracted from $.meta[*] for pagination and other information.
    • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

    This endpoint retrieves all records of a specified resource type from a specific view in Freshsales. The endpoint requires API key authentication via the Token header, which is handled automatically by your credential configuration. The resource type determines which Freshsales API endpoint will be used, and the view ID determines which subset of records will be returned. Pagination is handled automatically, and the endpoint will fetch all pages until all records are retrieved. The endpoint supports various resource types including leads, contacts, deals, accounts, and users. For detailed information about available resource types, view IDs, and API response formats, see the Freshsales API documentation.

Configure Manually​

Freshsales data sources can be manually configured to ingest data from any valid Freshsales API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Freshsales sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Freshsales API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Freshsales API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Freshsales API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://), your Freshsales domain, and any required path parameters. Freshsales API endpoints typically follow the pattern https://{domain}/api/{resource_type}/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires API key authentication via the Token header, which is handled automatically by your credential configuration. The API key is sent in the format token={api_key} in the request header. The domain is automatically retrieved from your credential configuration. For detailed information about Freshsales API endpoints, authentication, and available APIs, see the Freshsales API documentation.