App Locations

On a page of the Freshservice user interface, there are various locations where an app can be rendered. This section specifies the locations and how to configure the manifest.json file, for an app to be displayed in the specified location. An app can be rendered in multiple locations.

Note: Freshservice apps are supported as web apps.

Global Navigation Pane

full_page_app - The app icon is displayed on the left navigation pane and when clicked, the app page occupies the entire viewport.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "full_page_app": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }

Note:
1. For a Freshservice account, only one full page app can be displayed.
2. The logo.svg file should have a resolution of 64 x 64 pixels and fill value set to FFF.

Ticket Details Page

ticket_sidebar - The app is displayed in the right sidebar on the Ticket Details page and is loaded only after you click the app icon.

manifest.json Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "ticket_sidebar": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }

ticket_requester_info - The app is displayed on the Requester Details tab and is loaded only after you click the app icon.

manifest.json Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "ticket_requester_info": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }

ticket_top_navigation - The app is displayed on the top navigation bar on the Ticket Details page and is loaded only after you click the app icon.

Note:
Only svg icons are supported, text cannot be added.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "ticket_top_navigation": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }

ticket_background - This location is used for apps that run in the background of the Ticket Details page.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
"product": { "freshservice": { "location": { "ticket_background": { "url": "myfirstapp.html" } } } }
Change Details Page

change_sidebar - The app is displayed in the right sidebar on the Change Details page and is loaded only after you click the app icon.

manifest.json Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "change_sidebar": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }

change_background - This location is used for apps that run in the background of the Change Details page.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
"product": { "freshservice": { "location": { "change_background": { "url": "myfirstapp.html" } } } }
Contact Details Page

contact_sidebar - The app is displayed in the right sidebar on the Requester Details page.

manifest.json Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "contact_sidebar": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }
New Ticket Page

new_ticket_sidebar - The app is displayed in the right sidebar on the New Ticket page.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "new_ticket_sidebar": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }

new_ticket_background - The app runs in the background of the New Ticket page.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
"product": { "freshservice": { "location": { "new_ticket_background": { "url": "myfirstapp.html" } } } }
New Change Page

new_change_sidebar - The app is displayed in the right sidebar on the New Change page.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "new_change_sidebar": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }

new_change_background - The app runs in the background of the New Change page.

manifest.json

Copied Copy
1
2
3
4
5
6
7
8
9
"product": { "freshservice": { "location": { "new_change_background": { "url": "myfirstapp.html" } } } }
Asset Details Page

asset_sidebar - The app is displayed in the right sidebar on the Asset Details page.

manifest.json Copied Copy
1
2
3
4
5
6
7
8
9
10
"product": { "freshservice": { "location": { "asset_sidebar": { "url": "myfirstapp.html", "icon": "logo.svg" } } } }