App Locations

App locations specify the location in which apps can be rendered. This has to be configured in the manifest file. A single app can be rendered in multiple locations.

Note:
Freshservice apps are only supported in web applications and not in mobile applications.

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" } } } }