Freshsales is a CRM and is part of the broader Freshwork suite. With Freshpaint and Freshsales together, you can sync users in Freshpaint to contacts and leads in Freshsales.

Getting Started

To set up the Freshsales integration, do the following steps:
  1. 1.
    Go to Freshsales and navigate to Settings > API Settings.
  2. 2.
    Copy and paste your API Key, along with your Freshsales subdomain into Freshpaint.


When you call freshpaint.identify, Freshpaint will create or update either a lead or a contact in Freshsales. In order for Freshsales to properly merge users together, you must use email as your user identifier in Freshpaint.
By default, Freshpaint will create users as leads. If you would like to create users as contacts instead pass the property:
fs_contact: true
Any user properties passed to Freshpaint will be mapped to the corresponding Freshsales property with the same builtin name. You can see a list of the properties Freshsales supports for leads here and for contacts here.


Events sent to Freshsales will show up as sales activities. In order for an event to show up as a sales activity, Freshsales needs a few things:

Sales Activity Type ID

Events must have one of the following:
1. The event has a "sales_activity_type_id": <number> property corresponding to one of the default sales activity types or a custom sales activity type you've created in your account. Note the value must be a number.
2. The name of the event must match the internal name of a sales activity type.
Freshsales is unable to process events that do not have a sales activity type provided in one of these ways
See Freshsales' documentation for more about sales activity types.

User identity (email address)

In order for Freshsales to properly associate the sales activity with a user in Freshsales, you must first identify the user with the email of the user.
Freshsales is unable to process events that are not associated with users identified by an email address.
By default, Freshpaint will attach the sales activity to a lead with the user's email. If you add the property "fs_contact": true as an event property, Freshpaint will attach the event to a contact with the user's email instead.
Last modified 3mo ago