Freshworks Developer Docs | Use data method

Data method is an interface that the developer platform provides to enable your app to retrieve product data (in the form of JSON payloads).

When an app is initialized successfully, the parent app (Freshsales Classic) passes a client reference to your app. Your app can use this reference and the developer platform’s data method to retrieve the different objects on the Freshsales Classic UI, as payloads.

To enable your app to retrieve product data, in the app.js file,

Subscribe to the app.initialized event, through an event listener. When the app is initialized, the parent application passes a client reference to the app.
After app initialization, use the data method - client.data.get(<objectName>) - to retrieve the specified object (<objectName>) from the product UI.

As part of the app logic, your app can process the retrieved payload to derive meaningful results.

This section,

Lists all the objects that can be retrieved by using the data method.
Describes all the attributes of the retrieved object.

Data objects accessible from all pages

These objects are available in all pages of the product UI. Irrespective of the page on which the app is deployed, when you use the data method -client.data.get(<objectName>)- and retrieve these objects, the corresponding payload is retrieved.

An app can retrieve the following objects irrespective of where the app is deployed:

loggedInUser

Use the sample code shown on the right pane > Sample code tab, to retrieve information on the agent logged into the Freshsales Classic UI.

Attributes of the loggedInUser object

idinteger
Identifier of the user.
created_atstring
Timestamp of when the logged in user’s details are saved in Freshsales Classic, specified in the UTC format.
territory_idsarray of strings
Identifiers of the territories to which the user is associated for auto-assignment of prospects.
signaturestring
HTML format of the personalized message block appended to the emails/replies that the user sends.

Sample code

Sample payload

async function getLoggedInUserData() {
  try {
    const data = await client.data.get("loggedInUser");
    // success operation
    // "data" is {loggedInUser: {‘available’: “true”, ... }}
  } catch (error) {
    // failure operation
  }
}

getLoggedInUserData();

domainName

Use the sample code shown on the right pane > Sample code tab, to retrieve the domain name of the business account that uses Freshsales Classic.

Attributes of the domainName object

domainNamestring
Domain of the company.

Sample code

Sample payload

async function getDomainName() {
  try {
    const data = await client.data.get("domainName");
    // success operation
    // "data" is {domainName: "sample.freshsales.io"}
    console.log(data);
  } catch (error) {
    // failure operation
    console.error(error);
  }
}

getDomainName();

Lead details page

An app deployed on the Lead details page can use the client.data.get(<objectName>) data method and retrieve the following object:

currentEntityInfo

currentEntityInfo

Use the sample code shown on the right pane > Sample code tab, to retrieve information of a lead, when an agent is on the Lead details page.

Attributes of the currentEntityInfo object

currentEntityIdinteger
Identifier of the lead.
currentEntityTypestring
Type of page.

Sample code

Sample payload

async function getCurrentEntityInfo() {
  try {
    const data = await client.data.get("currentEntityInfo");
    // success output for lead
    // data: { "currentEntityInfo": { "currentEntityId": 12, "currentEntityType": "lead"}}
    console.log(data);
  } catch (error) {
    // failure operation
    console.error(error);
  }
}

getCurrentEntityInfo();

Contact details page

An app deployed on the Contact details page can use the client.data.get(<objectName>) data method and retrieve the following object:

currentEntityInfo

currentEntityInfo

Use the sample code shown on the right pane > Sample code tab, to retrieve information of a contact, when an agent is on the Contact details page.

Attributes of the currentEntityInfo object

currentEntityIdinteger
Identifier of the contact.
currentEntityTypestring
Type of page.

Sample code

Sample payload

async function getCurrentEntityInfo() {
  try {
    const data = await client.data.get("currentEntityInfo");
    // success output for contact
    // data: { "currentEntityInfo": { "currentEntityId": 12, "currentEntityType": "contact"}}
    console.log(data);
  } catch (error) {
    // failure operation
    console.error(error);
  }
}

getCurrentEntityInfo();

Deal details page

An app deployed on the Deal details page can use the client.data.get(<objectName>) data method and retrieve the following object:

currentEntityInfo

currentEntityInfo

Use the sample code shown on the right pane > Sample code tab, to retrieve information of a deal, when an agent is on the Deal details page.

Attributes of the currentEntityInfo object

currentEntityIdinteger
Identifier of the deal.
currentEntityTypestring
Type of page.

Sample code

Sample payload

async function getCurrentEntityInfo() {
  try {
    const data = await client.data.get("currentEntityInfo");
    // success output for contact
    // data: { "currentEntityInfo": { "currentEntityId": 12, "currentEntityType": "deal"}}
    console.log(data);
  } catch (error) {
    // failure operation
    console.log(error);
  }
}

getCurrentEntityInfo();

Sales account details page

An app deployed on the Sales account details page can use the client.data.get(<objectName>) data method and retrieve the following object:

currentEntityInfo

currentEntityInfo

Use the sample code shown on the right pane > Sample code tab, to retrieve information of an account, when an agent is on the Sales account details page.

Attributes of the currentEntityInfo object

currentEntityIdinteger
Identifier of the account.
currentEntityTypestring
Type of page.

Sample code

Sample payload

async function getCurrentEntityInfo() {
  try {
    const data = await client.data.get("currentEntityInfo");
    // success output for account
    // data: { "currentEntityInfo": { "currentEntityId": 12, "currentEntityType": "sales_account"}}
    console.log(data);
  } catch (error) {
    // failure operation
    console.log(error);
  }
}

getCurrentEntityInfo();

Tutorials

Sample apps

Guides

Blogs

Assist catalog

Events

Use data method

Data objects accessible from all pages

loggedInUser

domainName

Lead details page

currentEntityInfo

Contact details page

currentEntityInfo

Deal details page

currentEntityInfo

Sales account details page

currentEntityInfo

Tutorials

Sample apps

Guides

Blogs

Assist catalog

Events

Use data methodOn this page

Data objects accessible from all pages

loggedInUser

domainName

Lead details page

currentEntityInfo

Contact details page

currentEntityInfo

Deal details page

currentEntityInfo

Sales account details page

currentEntityInfo

Use data method