App Manifest

The manifest.json file contains information such as the platform version used by a product, locations on the product UI where an app can be rendered, dependent files used by the app, and third-party domains with which the app can interact. This section details the various parameters of the manifest.json file.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
{ "platform-version": "2.0", "product": { "freshteam": { } }, "dependencies": { "request": "2.72.0" }, "whitelisted-domains": [ "https://www.google.com" ] }
EXPAND ↓

Parameters

Parameter Name Date Type Description
platform-version string Is auto-generated, when the app files are created, and specifics the version of the platform used to build the app. The version information is used to ensure backward compatibility when a new platform version is released.
product
Mandatory
object Associates a Freshworks product with the information that is necessary to render the app on the specified product.
(Child parameter: freshteam)
freshteam
Mandatory
object Specifies information that is necessary to render the app on the Freshteam UI.
(Child parameter: location)
dependencies
object Specifies the npm packages used by the app, in the “<package_name>”:”<version_number>” format.
For more information, see npm packages.
whitelisted-domains
array of string To make secure HTTP calls to third-party domains, the app needs to use the Request Method. For the method to work, the third-party domains need to be listed as the whitelisted-domains parameter value. For more information, see the Configure the Request method section.