Skip to main content

Freshsales Destination

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 sends data to a Freshsales location.
freshsales.png

Freshsales

Create a Freshsales Destination​

  1. Click the + icon on the Nexset that will be sent to the Freshsales destination, and select the Send to Destination option from the menu.

  2. Select the Freshsales connector from the list of available destination 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 destinations can be created using pre-built endpoint templates, which expedite destination setup for common Freshsales endpoints. Each template is designed specifically for the corresponding Freshsales endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

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

Configure Using a Template​

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

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create resource

    Create new resource of a given type

    • Enter the resource type you want to create in the Resource type field. This should be the type of resource you want to create, such as leads, contacts, deals, accounts, or users. The resource type determines which Freshsales API endpoint will be used to create the resource.
    • The endpoint uses POST requests to https://{domain}/api/{resource_type} where {domain} is your Freshsales domain and {resource_type} is the value you configured. The endpoint URL is automatically constructed based on your credential configuration and the resource type you specify.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the resource data to create.
    • Batch mode is disabled by default for this endpoint (batch.mode: false), which means each record from your Nexset will be sent as a separate API request. This ensures that each resource is created individually.
    • This endpoint does not automatically create a data source to track the responses received from the Freshsales API after each call.

    The request body must be properly formatted JSON that matches the Freshsales API specification for creating resources. The endpoint requires API key authentication via the Token header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. The API key is sent in the format token={api_key} in the request header. The domain is automatically retrieved from your credential configuration. The resource type determines which Freshsales API endpoint will be used, and the request body must contain the required fields for that resource type. For detailed information about creating resources, including required fields, field names, and request formats, see the Freshsales API documentation.

Configure Manually​

Freshsales destinations can be manually configured to send data to 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 destinations, such as destinations that use custom request headers, different HTTP methods, or custom data formatting.

Content Format​

  1. Select the format in which the Nexset data will be sent to the Freshsales API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Freshsales API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Freshsales API endpoint to which you want to send the Nexset data in the 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.