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 (Freshworks product) 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 Freshworks product 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 that common module app can access
A common module app can use the data method - client.data.get(<objectName>) - and retrieve the following objects and the corresponding payload.
currentHost
A global app, with module-specific app logic, can be deployed on various Freshworks products. currentHost refers to the Freshworks product on which the app is currently running. Based on the currentHost, from the back-end, we retrieve the modules that the app user working on the currentHost has subscribed to. Based on the subscribed modules, we can retrieve the product-specific urls that the app built for the modules can use, to access the product resources.
For more information on currentHost, see Global app concepts.
Use the sample code shown on the right pane > Sample code tab, to retrieve the currentHost object that contains information on,
- All modules that the app user using the currentHost has access to and applicable to the app.
- All product names and the corresponding account urls through which the app built for the subscribed modules can access product resources.
Attributes of the currentHost object
- subscribed_modulesarray of strings
All modules that the app user has subscribed to and present in the app manifest.
- endpoint_urlsobject
Product name and account url (domain name) to access product resources, specified as a key (product name) - value (account URL) pair.
You can use the domain name to construct api calls that can access product resources.
loggedInUser
Use the sample code shown on the right pane > Sample code tab, to retrieve information on the user logged into the Freshworks product UI.
Attributes of the loggedInUser object
- idinteger
Identifier of the user.
- display_namestring
Display name of the user.
- emailstring
Email address of the user.
- is_activeboolean
Specifies whether the user is active to accept new leads, contacts, tasks, appointments, and so on.
- work_numberstring
Official number of the user.
- mobile_numberstring
Mobile number of the user.
- confirmedboolean
Specifies whether the user has accepted the account activation mail.
- privilegesstring
Access privileges assigned to the user, specified through a role id.
- job_titlestring
Designation of the user.
- languagestring
Language of the user, in the ISO-639 code. By default, the value of this attribute is en.
- last_login_atstring
Timestamp of when the user last logged into the Freshworks product system, specified in the UTC format.
- time_zonestring
Time zone to which the user belongs.
- avatarstring
URL of the image used as the avatar.
- signaturestring
HTML format of the personalized message block appended to the emails/replies that the user sends.
- access_scopestring
Access scope of the user based on the role assigned to the user. The access can be global, restricted, or territory.
- abilitiesarray of strings
List of the access privileges granted to the agent, specified as an array.
- reply_tostring
Email address in which the user can receive responses.
- fromstring
Email address using which the user can send emails from the Freshworks product account.
- plan_namestring
Freshworks product plan under which the user’s account falls.
- imap_configured_emailstring
User’s email address that is connected to Freshworks product so that all prospect details are received directly in the product.
- deal_pipeline_idstring
Identifier of preferred deal pipeline that is associated with the user..
- created_atstring
Timestamp of when the logged in user’s details are saved in Freshworks product, specified in the UTC format.
- is_forgottenboolean
Specifies whether the user details are permanently deleted from the Freshworks product system.
- role_idnumber
Identifier of the role associated with the user. When a role is configured in Freshworks product, an auto-generated identifier is associated with the role.
- territory_idsarray of strings
Identifiers of the territories to which the user is associated for auto-assignment of prospects.
- account_idinteger
Identifier of the Freshworks product account to which the user is associated.
- sales_activity_type_idsarray of numbers
Identifiers of all sales activity types configured for a user