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.
Getting started
Before configuring Freshsales as a destination in RudderStack, verify if the source platform is supported by Freshsales by referring to the table below:
Connection Mode | Web | Mobile | Server |
---|---|---|---|
Device mode | - | - | - |
Cloud mode | Supported | Supported | Supported |
Once you have confirmed that the source platform supports sending events to Freshsales, follow these steps:
- From your RudderStack dashboard, add a source. Then, from the list of destinations, select Freshsales.
- 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.
- Domain: Enter the subdomain of your Freshsales account. For example, if your organization URL is
testcompany.myfreshworks.com
, then the subdomain istestcompany
.
- 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:
Attribute | Type | Description |
---|---|---|
unique_identifier | String | RudderStack passes the user's email . |
contact | Hashed Object | RudderStack passes the other relevant user details required to create or update the user in Freshsales. |
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:
RudderStack property | Freshmarketer property |
---|---|
traits.email context.traits.email Required | emails |
traits.firstname traits.first_name traits.firstName context.traits.firstname context.traits.first_name context.traits.firstName | first_name |
traits.lastname traits.last_name traits.lastName context.traits.lastname context.traits.last_name context.traits.lastName | last_name |
traits.subscriptionStatus context.traits.subscriptionStatus | subscription_status |
traits.job_title traits.jobTitle context.traits.job_title context.traits.jobTitle | job_title |
traits.phone context.traits.phone | work_number |
userId | external_id |
traits.mobileNumber context.traits.mobileNumber | mobile_number |
traits.address context.traits.address | address |
traits.address.city traits.city context.traits.address.city context.traits.city | city |
traits.address.state traits.state context.traits.address.state context.traits.state | state |
traits.address.postalCode traits.zip traits.zipcode context.traits.zip context.traits.zipcode context.traits.address.postalCode | zipcode |
traits.address.country traits.country context.traits.address.country context.traits.country | country |
traits.salesAccounts context.traits.salesAccounts | sales_accounts |
traits.territoryId context.traits.territoryId | territory_id |
traits.leadSourceId context.traits.leadSourceId | lead_source_id |
traits.ownerId context.traits.ownerId | owner_id |
traits.subscriptionTypes context.traits.subscriptionTypes | subscription_types |
traits.medium context.traits.medium | medium |
traits.campaignId traits.campaign_id context.traits.campaignId context.traits.campaign_id context.campaign.name | campaign_id |
traits.keyword context.traits.keyword context.campaign.term | keyword |
traits.timeZone context.traits.timeZone | time_zone |
traits.facebookUserName context.traits.facebookUserName | facebook |
traits.twitterUserName context.traits.twitterUserName | twitter |
traits.linkedinUserName context.traits.linkedinUserName | linkedin |
createdAt | created_at |
timestamp | updated_at |
traits.contactStatusId context.traits.contactStatusId | contact_status_id |
traits.salesAccountId context.traits.salesAccountId | sales_account_id |
traits.lifecycleStageId context.traits.lifecycleStageId | lifecycle_stage_id |
Track
The track
call can be used to track the user activities in Freshsales.
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:
RudderStack property | Freshsales property |
---|---|
email Required | email |
lifecycleStageName Required, if lifecycleStageId is absent. | lifecycleStageName |
lifecycleStageId Required, if lifecycleStageName is absent. | lifecycle_stage_id |
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:
RudderStack property | Freshsales property |
---|---|
properties.title Required | title |
properties.salesActivityName Required, if properties.salesActivityTypeId is absent. | sales_activity_name |
properties.salesActivityTypeId Required, if properties.salesActivityName is absent. | sales_activity_type_id |
properties.startDate Required | start_date |
properties.endDate Required | end_date |
context.externalId.type Required | targetable_type |
properties.ownerId Required | owner_id |
salesActivityOutcomeId | sales_activity_outcome_id |
properties.notes | notes |
context.externalId.id | targetable_id |
properties.createrId | creater_id |
originalTimestamp | created_at |
timestamp | updated_at |
properties.location | location |
latitude context.address.latitude context.location.latitude | latitude |
longitude context.address.longitude context.location.longitude | longitude |
properties.checkedinAt | checkedin_at |
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:
Attribute | Type | Description |
---|---|---|
unique_identifier | String | RudderStack passes the account name . |
sales_account | Hashed Object | RudderStack passes the other relevant details associated with the Freshsales account. |
- 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 thecontext.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:
RudderStack property | Freshsales property |
---|---|
name Required | name |
traits.industryTypeId context.traits.industryTypeId | industry_type_id |
traits.businessTypeId context.traits.businessTypeId traits.business_type_id context.traits.business_type_id | business_type_id |
phone | phone |
traits.numberOfEmployees context.traits.numberOfEmployees | number_of_employees |
traits.annualRevenue context.traits.annualRevenue | annual_revenue |
traits.address context.traits.address | address |
traits.city traits.address.city context.traits.city context.traits.address.city | city |
traits.state traits.address.state context.traits.state context.traits.address.state | state |
traits.country traits.address.country context.traits.country context.traits.address.country | country |
zipcode | zipcode |
traits.website context.traits.website | website |
traits.territoryId context.traits.territoryId | territory_id |
traits.parentSalesAccountid context.traits.parentSalesAccountid | parent_sales_account_id |
traits.ownerId context.traits.ownerId | ownerId |
traits.facebookUserName context.traits.facebookUserName | facebook |
traits.twitterUserName context.traits.twitterUserName | twitter |
traits.linkedinUserName context.traits.linkedinUserName | linkedin |
createdAt | created_at |
timestamp | updated_at |
FAQ
Where can I find the Freshsales API key?
To obtain your Freshsales API key, follow these steps:
- Log into your Freshsales dashboard.
- Go to Personal Settings > API Settings.
- Enable the captcha to complete the authentication process.
- You will find your Freshsales API key listed under the API Authentication section, as shown:
Contact us
For more information on the topics covered on this page, email us or start a conversation in our Slack community.