FDK 6.13.0: As part of our ongoing initiatives that enable developers to build secure apps, the app development platform has been upgraded. The latest platform version is 2.2. When building apps on the latest platform version,
- Ensure that all SMI functions/methods, defined in the serverless component of an SMI app, are registered (allow listed) in the app manifest. To enable this, a new attribute (functions) has been introduced in manifest.json. The functions attribute also contains a provision to specify function-based app execution timeouts for an SMI app.
- Ensure that all events defined in the server.js file of a serverless app and the corresponding callback methods are registered in manifest.json. To enable this, an attribute (events) has been introduced in manifest.json.
FDK 6.12.0: Known issues and minor bugs have been fixed.
FDK 6.11.1: Known issues and minor bugs have been fixed.
The App Management Portal (AMP) / Apps gallery that can be accessed through Admin > Helpdesk Productivity > Apps has been enhanced to provide a better user experience. For information on the different types of apps and how to submit an app through the new AMP, see Marketplace Listing.
FDK 6.11.0: The FDK has been enhanced to ensure that all Request method calls to third-party domains are secure. This is achieved through domain whitelisting. For more information, see App Manifest.
FDK 6.9.8, FDK 6.9.9, and 6.10.0: Known issues and minor bugs have been fixed.
FDK 6.9.5, 6.9.6, and 6.9.7: Known issues and minor bugs have been fixed.
FDK 6.9.0, 6.9.1, 6.9.2, 6.9.3, and 6.9.4: Known issues and minor bugs have been fixed.
FDK 6.8.0: Known issues and minor bugs have been fixed.
FDK 6.7.0, 6.7.1, and 6.7.2: Known issues and minor bugs have been fixed.
FDK 6.6.1, 6.6.2, and 6.6.3: Known issues and minor bugs have been fixed.
FDK 6.5.5, 6.5.6, and 6.6.0: Known issues and minor bugs have been fixed.
Support has been added for the full page app placeholder.
FDK v6.5.4: Known issues and bugs have been fixed.
FDK v6.5.3: Known issues and bugs have been fixed.
FDK v6.5.2: Support has been added for a new iparams attribute, visible, that enables displaying or hiding an iparam on the installation page.
FDK v6.5.1: Support has been added to detect sensitive iparams when running the fdk validate and fdk pack commands and display a warning to mark them as secure.
FDK v6.5.0: Known issues and bugs have been fixed.
FDK v6.4.0: Known issues and bugs have been fixed.
FDK v6.3.2: Known issues and bugs have been fixed.
As part of CLI v6.3.1, the OAuth refresh token handler has been enhanced to use appropriate refresh tokens to retrieve access tokens. At times, third-party resource providers do not issue new refresh tokens as part of their refresh strategy. The handler uses the old refresh token in such cases.
As part of CLI v6.3.0, the FDK has been enhanced to include a testing framework (beta) that enables creating automated unit tests for serverless apps. The framework uses the popular mochaV5. For information on how to write and run tests, see the Testing Framework documentation.
As part of CLI v6.2.7, the --fix option has been added to the validate command, to enable auto-fixing certain lint errors.
As part of CLI v6.2.6, some FDK bugs have been fixed.
As part of CLI v6.2.5, some FDK bugs have been fixed.
As part of CLI v6.2.4, the FDK has been updated to load static resources over HTTPS, by default.
As part of CLI v6.2.2, we have added fixes for number of bugs.
We have documented Lint validations which happen when running the fdk validate and fdk pack commands on an app.
As part of CLI v6.1.1, we have added support for two new types of installation parameters, domain and api_key, to validate the domain name and API key specified for a product, during app installation.
To accommodate the changes in Chrome 79 and higher versions, where HTTPS pages only load secure subresources, the app testing process has been modified. According to the latest Chrome release notes, HTTPS pages will only be able to load secure subresources, with changes from Chrome 79 to Chrome 81.
The following enhancements have been made:
- In Request method, added new options, maxAttempts and retryDelay, and a new attribute, attempts.
- You can test external events on your computer using ngrok.
As part of CLI v6.0.1,
- You need to uninstall the previous CLI version by using the npm uninstall fdk -g command and install the latest CLI version.
- When testing scheduled events on your computer, the schedules will be triggered at the specified time and frequency after they are created or updated.
As part of CLI v6.0.0, added support for Node 10.x. Support for Node 8.10.x has been deprecated.
As part of CLI v5.4.0, the iparam_test_data.json file has been deprecated. Before testing the app, navigate to http://localhost:10001/custom_configs and enter appropriate values for the configured installation parameters.
As part of CLI v5.3.0, added fixes for a number of minor bugs.
As part of CLI v5.2.6, added fixes for a number of minor bugs.
As part of CLI v5.2.5, added fixes for a number of minor bugs.
As part of CLI v5.2.4, added fixes for a number of minor bugs.
As part of CLI v5.2.1, added fixes for a number of minor bugs.
As part of CLI v5.1.0, added fixes for a number of minor bugs.
As part of CLI v5.0.9, added fixes for a number of minor bugs.
As part of CLI v5.0.8, the README.md file, describing app features and working, can now be packed in the app zip file.
As part of CLI v5.0.7, added fixes for a number of minor bugs.
As part of CLI v5.0.6, added fixes for a number of minor bugs.
As part of CLI v5.0.4, you can now detect bugs in your app caused by improperly assigned variables.
Introduced support for the following:
- Timer event methods for Change Details page.
- Data methods for the Planning section in Change Details page.
- Events methods for Planned Start Date, Planned End Date, and Custom Change fields on both New Change and Change Details pages.
- Set value Interface methods for dependent fields in New Ticket, Ticket Details, New Change, and Change Details pages.
As part of CLI v5.0.3, added fixes for a number of minor bugs.
As part of CLI v5.0.2, added fixes for a number of minor bugs.
The new CLI v5.0.0 adds support for Node 8.10.x. For more information, see Moving on to Node.js 8.
As part of the latest CLI version (v4.9.2), support for rendering apps in the Asset Details Page has been introduced. Interface methods can also be rendered on the Asset Details page and details of the asset can be fetched by using the Asset Data method.
Support for agent level oAuth
Apps can now make requests that are authenticated using JSON Web Tokens (JWT)
Added support for Scheduled Events which enable serverless apps to be executed in response to one time or recurring schedules.
The Server Method Invocation (SMI) feature allows the front-end component of an app to invoke the serverless component. Typically, apps that run on front-end events (app loaded, button clicked, ticket status changed, etc.) have the app.js file executed in a browser. And, apps that run on product events, app setup events, or external events have the server.js file executed in a server.
A single app can be present in multiple locations on the same page. In addition, a location may open up one or more modals. The locations and modals can be thought of as separate instances of the app and can be resized, closed, and communicate with each other. The app framework provides instance APIs to enable these use cases. Please refer to the documentation for more details.
Introduced support for Serverless capability in CLI v4.0.0 and higher. This capability enables building apps that run in response to events such as Freshservice product, app setup, and external events.
Extended event methods to support custom ticket fields on both New Ticket page and Ticket Details page. Added new interface methods to support set value for Change properties in New Change page and Change Details page.
Extended Interface APIs for:
Introduced support for:
Added support for testing out the app installation experience using Custom Installation page. Once you have filled in the fields, you can press the “Install” button to test the app using the entered values.
Optimized payload structure for the following items:
- Global Method - Logged In User
- Global Method - Domain name
- Change Data Method - Change
- Change Data Method - Requester
- Contact Data Method - Requester
- Contact Data Method - Department
Introduced the following methods:
- Interface methods for Urgency and Impact in New Tickets page and Ticket Details page.
- Events methods to listen the ticket property values post update.
- Interface methods to update and submit the ticket properties.
- Events methods for subject change and requester change in New Tickets Page.
- Events methods for start, stop, update & delete timer in Ticket details page
- Interface methods to show/hide custom change properties
- Interface methods to show/hide/disable the default Group and Category fields in New Ticket page and Ticket details page
As part of CLI v4.3.2, introduced the below locations for apps rendering
- new_change_sidebar and new_change_background for New Change page
- change_background for Change Details page
Released official samples apps for marketplace platform for Freshservice. To learn about how to start creating apps, please take a look at the source code of the samples
Introduced support for:
Enhancement to payload structure with respect to data methods for ticket associations
- Associated Problem
- Associated Change
- Associated Tasks
- Recent Child Tickets
- Requester Assets
- Ticket Assets
As part of CLI v4.2.3, added New Ticket page as location for Freshservice apps.
Introduced support for:
Added new event for Ticket Details page to enable developers to invoke the app post Ticket Property load while using ticket_background location.
App.activated event will now be triggered based on the app location.
As part of CLI v4.2.1, added fixes for a number of minor Windows bugs.
The following enhancements have been made to Installation Parameters
- Added new types of parameters - URL, email, number, phone number, date, and multiselect
- Regexes can now be used to validate the parameters entered by the user
- Added support for setting installation parameters as either required or optional
- Optional parameters do not need to be set in the iparam_test_data.json file