App Manifest

The app manifest is a JSON file manifest.json that contains information about your app such as the platform version, product, location, etc.

Copied Copy
1
2
3
4
5
6
7
8
9
10
{ "platform-version": "2.0", "product": { "freshservice": { "location": { "ticket_sidebar": { "url": "template.html", "icon": "logo.svg" } }

Platform-version
The platform-version is automatically generated and used to infer the platform version that your app uses. This will be used to ensure backward compatibility when a new version of the framework is released.


product
This section specifies the product and location where the app is rendered. product is a mandatory field. You can specify multiple locations for your app to be rendered in Freshservice. For more information, see App Locations.


Example

Copied Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
"product": { "freshservice": { "location": { "ticket_sidebar": { "url": "template.html", "icon": "logo.svg" }, "ticket_requester_info": { "url": "template.html", "icon": "logo.svg" } } } }
EXPAND ↓

The location field is mandatory for all type of apps except for serverless apps which do not have UI components, where the location can be omitted as shown in the example below:

Copied Copy
1
2
3
4
5
6
7
{ "platform-version": "2.0", "product": { "freshservice": { } } }

The following information will be given inside location:

  • url:In order to render your app in Freshservice UI, you will need to point the URL to the template file’s relative path from the app directory as shown in the following example: Copied Copy
    1
    2
    3
    4
    5
    6
    7
    { "platform-version": "2.0", "product": { "freshservice": { } } }
    Where templates is a directory inside myprojectfolder/app. Anything that you define within the template file will be rendered inside an iframe in the defined location. By default, the url will point to template.html inside the app directory.
  • icon:Icon file should be of the type SVG with a resolution of 64x64 pixels. You need to specify your app icon’s relative path from the app directory as shown in the above example. Copied Copy
    1
    2
    3
    4
    "ticket_sidebar": { "url": "templates/newtemp.html", "icon": "images/logo.svg" }
    Where logo.svg is a file inside the app directory.

whitelisted-domains
It is mandatory to use Request API to make secure HTTP requests to any third party domains. In order to use the request API, the list of domains should be specified in the manifest.json file. For more information, see Configure section.

Log in with your Freshservice account

Enter your helpdesk URL to proceed to login

Proceed

By clicking "Proceed", you agree to our Terms of Use.