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 file
Sample
Copied Copy1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | { "platform-version": "2.0", "product": { "freshcaller": { "location": { "notification_card": { "url": "template.html", "icon": "logo.svg" }, "conversation_card": { "url": "template.html", "icon": "logo.svg" } } } }, "dependencies": { "request": "2.72.0" }, "whitelisted-domains": [ "https://www.google.com" ] } |
Parameters
| Parameter Name | Date Type | Description |
|---|---|---|
| platform-version | string | When the app files are created, this field value is auto-generated. The value specifics which version of the platform is 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: Freshcaller) |
| Freshcaller Mandatory |
object | Specifies information that is necessary to render the app on the Freshcaller UI. (Child parameter: location) |
| location Mandatory |
object | Specifies the locations on the Freshcaller UI, where the app is to be rendered. For more information, see Placeholders (Child parameters: notification_card, conversation_card, widget_notification_card, widget_conversation_card) |
| notification_card |
object | Specifies information necessary to render the app, on the Freshcaller web UI, in the incoming call notification. Attributes: url, icon |
| conversation_card |
object | Specifies information necessary to render the app, on the Freshcaller web UI, in the conversation window that is displayed after a call is established. Attributes: url, icon |
| widget_notification_card |
object | Specifies information necessary to render the app, on the Freshcaller widget (in another product), in the incoming call notification. Attributes: url, icon |
| widget_conversation_card |
object | Specifies information necessary to render the app, on the Freshcaller widget (in another product), in the conversation window. Attributes: url, icon |
| url Mandatory |
string | Specifies the relative path from the app project directory to the template.html file based on which the app is rendered. The contents of the template.html file are used to render the app in an IFrame at the specified location. Default value: template.html (file in the app directory) |
| icon Mandatory |
string | Specifies the relative path from the app project directory to an image file (in SVG format). The image is used as the app’s icon when the app is rendered on the UI. The resolution of the image needs to be 64x64 pixels. Default value: icon.svg (file in the app directory) |
| 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 Mandatory |
array of string | To make secure HTTP calls to third-party domains, apps must use the Request Method. For the method to work, in manifest.json, the third-party domains must be listed as the whitelisted-domains.
For more information, see the section on how to Configure the Request method.
Notes:
|