Freshsales

• Freshsales for Web
• PHP Library

PHP Library

The Freshsales PHP Library helps you track the in-app activities of your customers using your web application.

Getting started

To install the library you must,

1. Download the latest version of PHP library zip here
2. Unzip the Library and add Freshworks CRMAnalytics.php in your project.
3. Instantiate the core analytics class Freshworks CRMAnalytics with the snippet below
   Copied Copy

   1
   2
   3
   4
   5
   6
   
     Freshworks CRMAnalytics::init(array(
     'domain' => "FRESHSALES_URL",
     'app_token' => "FRESHSALES_APP_TOKEN"
     );
               

   EXPAND ↓

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

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
4
5
6
7
8
9
10
11
12

  Freshworks CRMAnalytics::identify(array(
    'identifier' => '123456',
    'First name' => 'John',
    'Last name' => 'Doe',
    'Email' => 'john.doe@example.com',
    'company' => array(
      'Name' => 'Example.com',
      'Website' => 'www.example.com'
   )
  ));
          

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

  Freshworks CRMAnalytics::identify(array(
    'identifier' => $user->id,
    'First name' => $user->first_name,
    'Last name' => $user->last_name,
    'Email' => $user->email,
    'company' => array(
      'Name' => $user->company_name,
      'Website' => $user->company_website
   )
  ));
          

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
4
5
6

  Freshworks CRMAnalytics::trackPageView(array(
    'identifier' => '123456',
    'url' => 'https://www.myfreshworks.com/crm/sales/libraries/php')
  );
          

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
4
5
6
7
         
  Freshworks CRMAnalytics::trackEvent(array(
    'identifier' => '123456',
    'name' => 'Inviting Users',
    'user email' => 'user@abc.com'
  ));  
          

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 work

1
2
3
4
5
6
7
8
9
10
11

  Freshworks CRMAnalytics::identify(array(
    'identifier' => '123456',
    sample_properties => array(
      'Payment id' => 129863,
      'Plan name' => '2 agents',
      'Amount' => 2500,
      'Alternate contact number' => '98765432'
   )
  ));