App on Freshworks developer platform can be located in different placeholders. Some of them render with UI, without UI or simply serverless. This app contains the sample code that is all available for apps those run on browser in-product experience.
full_page_app
- The app icon is displayed on the left navigation pane and when clicked, the app page occupies the entire viewport.
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.
ticket_requester_info
- The app is displayed on the Requester Details tab and is loaded only after you click the app icon.
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.
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.
- Make sure you have a trial Freshservice account created. You can always sign up
- Ensure that you have the Freshworks CLI installed properly.
# Run the app
> fdk run
# You will need to append ?dev=true in the URL on every page.
# see browser console for a log from relavant app placeholder
Apps render without UI
- There are couple of app placeholders where app run in background and not backend.
- These placeholders generally have background in their name. For example,
ticket_background
,new_ticket_background
,change_background
,new_change_background
. - Apps those render without UI will load scripts as soon as user navigates to relavant page in Freshservice. For example, the browser's js thread of execution will enter
.js
files inticket_background
when user navigates to Ticket details page on Freshservice