Freshsales

Freshsales is a CRM tool that lets you discover the best leads, drive them to closure, and nurture them to boost contextual engagement.

RudderStack supports Freshsales as a destination where you can seamlessly send your event data.

Connection compatibility

Destination Information
Status: Generally Available Supported sources: AMP , Android (Java) , Android (Kotlin) , Cordova, Cloud, Flutter, iOS (Obj-C) , iOS (Swift) , React Native , Unity, Warehouse, Web, Shopify Refer to it as Freshsales in the Integrations object.

Connection Modes
Source	Cloud mode	Device mode	Hybrid mode
AMP
Android (Java)
Android (Kotlin)
Cloud
Cordova
Flutter
iOS (Obj-C)
iOS (Swift)
React Native
Shopify
Unity
Warehouse
Web

Supported Message Types
Source	Identify	Page	Track	Screen	Group	Alias	Record	AudienceList
Cloud mode
Supported sources

Get started

Once you have confirmed that the source platform supports sending events to Freshsales, follow these steps:

1. From your RudderStack dashboard, add a source. Then, from the list of destinations, select Freshsales.
2. Assign a name to the destination and click Continue.

Connection settings

To successfully configure Freshsales as a destination, you will need to configure the following settings:

• API Key: Enter your Freshsales API key.

For more information on obtaining your Freshsales API key, refer to the FAQ section below.

• Domain: Enter the full organization URL associated with your Freshsales account. For example, testcompany.myfreshworks.com.

For more information on your organization URL and how to change it, refer to this Freshsales support guide.

• Map your events with Freshsales Standard Events: Use this setting to map the standard Freshsales events with the custom event names.

Identify

You can use the identify call to create or update your Freshsales contact.

RudderStack uses the Freshsales Upsert a Contact API to pass the relevant user information via the following parameters:

If email already exists, the contact details are updated. Otherwise, RudderStack creates a new user in Freshsales.

A sample identify call is shown below:

rudderanalytics.identify("1hKOmRA4GRlm", {
  email: "alex@example.com",
  firstName: "Alex",
  lastName: "Keener",
  state: "Louisiana",
  country: "USA",
  postalCode: "90009",
});

Supported mappings

The following table lists the mappings between the RudderStack and Freshsales properties:

Track

The track call can be used to track the user activities in Freshsales.

To make a track call successfully, you must map the event to be sent in the track call in the Map your events with Freshsales Standard Events dashboard setting.

RudderStack supports the following track events:

Lifecycle stage

Lifecycle stage events capture the decision journey of a customer. Refer to the Freshsales documentation to create lifecycle stages in Freshsales.

RudderStack lets you update the status of a contact in their lifecycle stage by using either the lifecycleStageId or lifecycleStageName.

lifecycleStageName is a case-sensitive field and throws an error if not used in the intended manner.

A sample track call for a lifecycle stage event is shown below:

rudderanalytics.track("eventName", {
  email: "alex@example.com",
  lifecycleStageId: 71010794467,
  phone: "+1-202-555-0146",
  owner_id: "70000090119",
});

The following table lists the property mappings betweeen RudderStack and Freshsales for lifecycle stage events:

Sales activities

Sales activities events can be used to track any activity related to a contact/deal/account. Refer to the Freshsales documentation to create sales activities in Freshsales.

RudderStack lets you create the status of a contact by using either the salesActivityTypeId or salesActivityName.

A sample track call for a sales activity event is shown below:

rudderanalytics.track("eventName", {
  salesActivityTypeId: "70000663932",
  title: "new contact",
  startDate: "2021-05-04T17:00:00+05:30",
  endDate: "2022-06-04T17:30:00+05:30",
  ownerId: "70054866612",
});

The following table lists the property mappings betweeen RudderStack and Freshsales for sales activity events:

The targetable_type field denotes the entity for which the sales activity has been created and can take Contact/SalesAccount/Deal as its value. However, if its value is set to contact, then either the targetable_id or email is required.

Group

The group call lets you link an identified Freshsales contact with a company, organization, or an account. You can also record any custom group traits like the company name, number of employees, etc.

RudderStack uses the Upsert an Account API to create or update a sales account via the following parameters:

Note that:

• If name already exists, the Freshsales account details are updated. Otherwise, a new account is created.
• RudderStack also checks if the contact’s email is present in the context.traits object. If yes, RudderStack links the contact to the Freshsales account.

A sample group call is shown below:

rudderanalytics.group(
  "group01", {
    name: "Alex Keener",
    phone: "1234567890",
    numberOfEmployees: 51,
    annualRevenue: 10000,
    zipcode: 90009,
    street: "6649 N Blue Gum Street",
    city: "New Orleans",
    state: "Louisiana",
    country: "USA"
  }, {
    context: {
      traits: {
        email: "alex@example.com"
      }
    }
  }
);

Supported mappings

The following table lists the mappings between the RudderStack and Freshsales properties:

FAQ

Where can I find the Freshsales API key?

To obtain your Freshsales API key, follow these steps:

1. Log into your Freshsales dashboard.
2. Go to Personal Settings > API Settings.
3. Enable the captcha to complete the authentication process.
4. You will find your Freshsales API key listed under the API Authentication section:

For more information, refer to this Freshsales support guide.