Freshsales

• Freshsales for Web
• Ruby Library

Ruby Library

The Freshsales Ruby library helps you track the in-app activity of customers in your web application. This library is open-source, so you can check it out on Github

Getting Started

1. Copy this snippet and paste it in the gem file and run bundle install.
   Copied Copy

   1
   2
   3
   
     gem 'freshsales-analytics', git:'git@github.com:freshdesk/freshsales-ruby-sdk.git'
           

   EXPAND ↓
2. Create a .yml file and name it "fs_analytics_config.yml" in the config folder of your web app.
3. Copy and paste the snippet below in the .yml file you created.
   Copied Copy

   1
   2
   3
   4
   
     app_token: "FRESHSALES_APP_TOKEN"
     url: "FRESHSALES_URL"
           

   EXPAND ↓

Replace the "FRESHSALES_URL"and "FRESHSALES_APP_TOKEN" with your app token and portal url. You can find it under Admin Settings > Integrations > Freshsales for Web > Ruby

Create Leads

You can use the identify method to create leads, track signups. You can find more details about this method's payload in identify spec

1
2
3

  FreshsalesAnalytics::identify(user_id, properties)
          

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  sample_user_properties = {
    'First name' => 'John',
    'Last name' => 'Doe',
    'Email' => 'john.doe@example.com',
    'company' => {
      'Name' => 'Example.com',
      'Website' => 'www.example.com'
    }
  }

  begin
    FreshsalesAnalytics::identify('123456', sample_user_properties)
  rescue FreshsalesAnalytics::Exceptions => exc
    p '#{exc.err_obj}: #{exc.message}'
  end
          

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  sample_user_properties = {
    'First name' => user.first_name,
    'Last name' => user.last_name,
    'Email' => user.email,
    'company' => {
      'Name' => user.company.name,
      'Website' => user.company.website
    }
  }

  begin
    FreshsalesAnalytics::identify("#{user.id}", sample_user_properties)
  rescue FreshsalesAnalytics::Exceptions => exc
    p '#{exc.err_obj}: #{exc.message}'
  end
            

Track Pageviews

You can use trackPageView method to track the pages that your users are viewing. You can find more details about this method in trackPageView spec

1
2
3

  FreshsalesAnalytics::trackPageView(user_id, url)
          

1
2
3
4
5
6
7

  begin
    FreshsalesAnalytics::trackPageView('123456', 'https://www.freshsales.io/libraries/ruby')
  rescue FreshsalesAnalytics::Exceptions => exc
    p '#{exc.err_obj}: #{exc.message}'
  end
          

Track Events

You can use trackEvent method to track all the in-app activities of your users like - adding users, enabling/disabling integrations, password resets, number of logins etc as events in Freshsales.

1. Pick the specific call to action buttons that you’d like to be notified about.
2. Call the trackEvent method on click of the button. You can find more details about this method's payload in trackEvent spec

1
2
3

  FreshsalesAnalytics::trackEvent(user_id, event_name, event_properties)
          

1
2
3
4
5
6
7
8
9
10
11

  sample_event_properties = {
    'user email' => 'user@abc.com'
  }

  begin
    FreshsalesAnalytics::trackEvent('123456', 'Inviting Users', sample_event_properties)
  rescue FreshsalesAnalytics::Exceptions => exc
    p '#{exc.err_obj}: #{exc.message}'
  end
          

Update Leads/Contacts

You can use the identify method to update the existing leads based on their activity in your application. Know more about How identify call works

1
2
3
4
5
6
7
8
9
10
11
12
13
14

  sample_user_properties = {
   'Payment Id' => 129863,
   'Plan Name' => '2 agents',
   'Amount' => $2500,
   'Custom Field' => 'custom field value'
  }

  begin
    FreshsalesAnalytics::identify('123456', sample_user_properties)
  rescue FreshsalesAnalytics::Exceptions => exc
    p '#{exc.err_obj}: #{exc.message}'
  end