Freshworks apps

1. Log in to your Freshworks product account.

2. Navigate to the corresponding apps gallery. In the Build your own apps section, click Build it yourself. The All Apps page of the Developer portal is displayed.

   Or

   Navigate to the Neo Admin Center page. In the My Accounts section, click on the developer account (/developer). The All Apps page of the Developer portal is displayed.

   Notes:
   • If multiple accounts are associated with the organization, the Choose an Account window is displayed. Select the account to view the All Apps page for the selected account.
   • In the All Apps page, you can switch between the accounts of the organization from the dropdown displayed.
   • In the Neo Admin Center page, the developer account (/developer) will be displayed under the My Accounts section only if the developer has navigated to the Developer portal at least once.
   The All Apps page

3. Click New App and select Freshworks App. The Create a new app page is displayed.

4. From Select your App type, select Freshworks App.

5. In the Upload Zip file section, click Upload App file, select the packed app file, and click Open. The packed app file is uploaded. Note:To replace the uploaded app file, click Replace App file, select the packed app file, and click Open. The packed app file is replaced.

6. To submit the app as a paid app, in the App Pricing section, select Paid.

   Important:
   • Global apps can be published as Freshworks paid apps on the Freshworks Marketplace for all products except Freshsales Classic.
   • An app built exclusively for the lead module( supported only by Freshsales Classic) or any app that has lead as one of its functional module cannot be published as a Freshworks paid app.
   Notes:

   • A paid app enables you to generate revenue whenever a customer installs your app from the Freshworks Marketplace. For more information, refer to Terms of Use.

   • After you submit an app as a paid app, you cannot modify the app to be a free app. To make the app available as a free app, resubmit the app as a Freshworks App with a different app name.

7. In the Name your App field, enter a meaningful name comprising two or three words.

8. Click Save and Continue. A page for entering the app details is displayed and the Works with section is auto-populated with the module(s) that your app works with, displayed as module cards. Each module card displays the name of the module and icons of the products that support the module.

   Note:The Works with section displays the module card of each module(s) that your app is configured to work with, except for the common module. Even if the app is configured to work with common module, the Works with section does not display a module card for the common module.

   Works with section

   Important:The supported products for each app are auto-assigned based on the modules configured in manifest.json. To modify the auto-assigned products, reach out to marketplace@freshworks.com.

   In the details panel on the left, the following values are auto-populated:

   1. The app’s name with the app status as Draft.
   2. The status of the app’s details such as Code Upload, App Information, Media and Installation, Support Details, Privacy and Security, and App settings (displayed only when the uploaded app file has app settings functionality).
   3. App type: Specifies how an app is available to an app user. Possible App types: Freshworks app (publicly displayed in the Marketplace), Custom app (private only to the customer using the product), External app (listed in an external website).
   4. App Id: An app’s identifier that is displayed after the app is published.
   5. Last updated: The timestamp of when the app was last modified.
   6. Code File: The status and versions of the uploaded app, displayed in chronological order. When a new Freshworks app file is uploaded, the status is Draft Version (Draft).
   Draft version of the app

9. To replace the uploaded app, in the Code File section, click the replace icon.

   Replace draft version of the app

   The Add New Version window is displayed. Click Replace to upload a new packed app file.

10. To submit the app as a paid app, fill out the requisite pricing details in the Pricing Details section.

    App supporting a single module

    App supporting multiple modules

    Set price for paid app

    Field	Description
    Pricing Method Mandatory	Select a pricing plan based on which customers are charged to use the app: Agent Per Month: Customers are charged the price specified in the Set Price field, for every agent using the app. Account Per Month: Each unique customer account is charged a fixed price specified in the Set Price field, irrespective of the number of agents using the app.
    Set Price for Each Currency Mandatory	Enter a price for app usage. Note: Ensure to enter values in all supported currencies such as AUD, BRL, EUR, GBP, INR, USD, and ZAR.

11. In the main section of the app details page, navigate to the App information tab and update the requisite app display details. Click Save and Continue. The Media and Installation tab is displayed.

    Important:
    • The app submission process is now enhanced by Freddy AI, allowing developers to easily update essential app details. You can describe your app’s problem statements, functionalities, features, and specifications, then click Generate to autofill the Name, Overview, Short Description, and Categories. Multiple suggestions will be provided, giving developers the option to choose from various options.
    • Click Regenerate for new suggestions. Additionally, developers can like or dislike each suggestion to refine the results further.

12. In the Media and Installation tab, update the requisite media, installation, and support details. Click Save and Continue. The Privacy and Security tab is displayed.

13. In the Privacy and Security tab, answer all the questions regarding the app’s end-user data practices.

14. If your app uses the app settings functionality, click Proceed. The App settings tab is displayed. In the App settings tab, update the requisite app settings details.

15. Click Save to save all the app, media, support, security, and app settings details.

16. To specify the app information in a language other than English (default language), navigate to the Multi-language setup tab and click Add language. A list of languages is displayed. Select the languages in which you want to specify app information and click Add. Sections corresponding to the languages are added. Navigate to each language section and in the fields displayed, enter the appropriate values.

17. Click Save and Publish, to submit the app for the approval process.

    In the details panel, the Last updated timestamp is updated. A View activities link is displayed. To view all app submission activities that have been performed, click View activities. The Activities page is displayed. In the Code File section the app status is updated as Draft Version (Under Review).

    Code file section

    After the app is reviewed and approved, it is published to the Freshworks Marketplace.

If the app is approved and published to Marketplace, in the App details page > Code File section, the status of the app is modified to Live Version (Published).

After the app is published, in the main section of the app details page, an App Sharing Settings section is displayed. You can provide limited accessibility to your app by hiding the app from the Marketplace and selectively sharing an account-specific URL. App users on that account can access the app through the shared URL. To do this,

1. In the App Sharing Settings section, set the Hide from gallery toggle key to on state. Note: When submitting an app, in the app details page > App information tab, if you had enabled Hide from gallery, this key is set to on by default.

2. In the Shareable URL input box, enter the full domain name (<sub-domain>.domain.com) of the customer account for which you want to make your app accessible.

   Example domain name: freshfoods.freshdesk.com

3. Click Generate URL. The shareable link to access your app is displayed below the Shareable URL input box.

   Sharable URL for selective access

App insights provide metrics or data that help you to assess your deployed apps. After the app is published, in the App details page > details panel, a View App Insights link is displayed. Click the link. In the main section, the following tabs are displayed.

• Ratings and Reviews
• Uninstall Feedback

To view the ratings and reviews that app users have provided for your app, navigate to the Ratings and Reviews tab. The cumulative (average) rating of your app is displayed along with the count of the number of users who have rated your app and the number of app installations. The elaborate reviews that the app users have provided is also displayed.

In the following image, is the count of the number of users who have rated the app and is the number of app installations, currently.

To reply to a review:

1. Click Reply to review. A text box is displayed.
2. Enter your response and click Post. The response is displayed along with the provision to edit or delete your response.Ratings and reviews for a published app

When engaging with users through your response, ensure to phrase the response such that it aligns to our community guidelines. To access the guidelines, under the Ratings and Reviews tab, click Community guidelines. The Community guidelines window is displayed.

Click the Uninstall Feedback tab to view any feedback provided when an app user uninstalls your app.

If the app is rejected, in the App details page > Code File section, the status of the app is modified to Draft Version (Rejected) and the uploaded app file is available for deleting or editing.

• To delete the uploaded app file, click Delete.
• To replace the uploaded app file, click Edit. The Add new version window is displayed. Click Replace to upload a new packed app file.

After uploading the new packed app file, in the Code File section, the status of the app is modified to Draft Version (Draft).

Publishing a new version of the app that supports more modules can extend an app's functionality to support more parent applications (the products on which the app is deployed after installation). The app manifest of the existing app can be modified to support more modules in the updated version.

Important: While uploading and submitting the new version of an existing app, ensure that the app still supports all the previously supported modules. Uploading and submitting a packed app file which does not support the earlier supported modules displays an error message.

When updating an existing app, Freddy AI can assist by generating new app details and recommending relevant categories. If preferred, you can retain your existing content.

To update your app content with Freddy AI, simply copy your current content, paste it into the App information tab, and select Generate. The newly generated content will overwrite the existing content, so it’s advisable for app developers to save the original content for future reference.

Note: Developers of existing apps are encouraged to use the Freddy AI-assisted submission process to update their apps with new categories and content. This can be done until December 2024. After that, the Freshworks Marketplace will begin automatically migrating all apps to the new categories.

To upload and submit a new version of an existing Freshworks app,

1. Navigate to the apps gallery.

2. In the Build your own apps section, click Build it yourself. The All Apps page of the Developer portal is displayed.

3. Click on the Freshworks app card corresponding to the published app for which you want to upload a new version. A page with the app details is displayed. In the details panel on the left, under the Code File > Live Versions section, all published app versions (up to a maximum of two latest versions) are listed.

4. In the Code File section, click Add new version. The Add new version window is displayed.

5. Click Click to upload and select the packed app file and click Open. The packed app file is uploaded and the Auto update toggle key is displayed.

   1. To replace the uploaded app file, click Replace.
   2. To automatically update in-use apps to the latest app version, set the Auto update toggle key to on state.
   Add new version window

6. In the Release Notes section of the Add New Version window, if the app has multi-language support, sections corresponding to the languages are displayed. Otherwise, a section for English (default section) is displayed. Navigate to each language section and enter pertinent information regarding all feature enhancements, updates, and bug fixes associated with the uploaded new version and click Save. The app details page is displayed. In the Code File section, the new version of the app is listed. The app status is Draft Version (Draft). Note: To successfully submit the new version, it is mandatory to enter the release notes in all supported languages.

7. To add the release notes later, select the Skip for now checkbox and click Save. The app details page is displayed. In the Code File section, the new version of the app is listed with a warning symbol. The Edit button displays a red dot which is a prompt to add the release notes.

   Edit button with a promt to add the release notes

8. In the main section of the app details page, navigate to the App information tab and update the requisite app display details. Click Save and Continue. The Media and Installation tab is displayed. Note: If the updated app supports new modules, ensure to include App Screenshots for the new modules added.

9. In the Media and Installation tab, update the requisite media, installation, and support details. Click Save and Continue. The Privacy and Security tab is displayed.

10. In the Privacy and Security tab, answer all the questions regarding the app’s end-user data practices.

11. If your app uses the app settings functionality, click Proceed. The App settings tab is displayed. In the App settings tab, update the requisite app settings details.

12. Click Save to save all the app, media, support, security, and app settings details.

13. To add a supported language in which the app information is displayed, navigate to the Multi-language setup tab and click Add language. A list of languages is displayed. Select the language you want to add and click Add. A section corresponding to the language is added. Navigate to the language section and in the fields displayed, enter the appropriate values. In the Code File section, the Edit button displays a red dot indicating that the release notes update is incomplete. To update the release notes in the newly added language, click Edit. The Add new version window is displayed. In the Release Notes section, navigate to the newly added language and update the corresponding content.

14. Click Save and Publish, to submit the app for the approval process. The app status is updated as Draft Version (Under Review) in the Code File section. Note: If the uploaded packed app file does not support the earlier supported modules, an error message is displayed.

15. If necessary, provide selective, account-specific access to your app.

After the app is reviewed and approved, it is available for app users, if they want to update their existing app. In the Installed Apps page, next to the app, a What’s New link is displayed along with an Update button. App users can click this link to read the Release Notes and then take a call on whether to update the app. The What’s New and the Update button are also available when app users navigate to the apps gallery (), select an app card, and view the app details. Note: If you have enabled auto-update for your app version, the What’s New content and the Update button are not displayed to app users. All in-use apps are automatically updated to the app version for which auto-update is enabled.

The app submission process is now enhanced by Freddy AI, allowing developers to easily update essential app details. You can describe your app’s functionalities, features, specifications, and problem statements in the App Display Details section, and then click Generate to autofill the Name, Overview, Short Description, and Categories. Multiple suggestions will be provided, giving developers the option to choose from various options.

For new suggestions, click Regenerate. Additionally, developers can like or dislike each suggestion to refine the results further.

The app display details to be displayed in the Freshworks Marketplace are captured in the following fields:

The media and Installation details to be displayed in the Freshworks Marketplace are captured in the following sections:

• Media
• Support Details

The details of how the app is utilizing the end-user's information is captured as answers to the questionnaire.

During app submission, ensure that all questions regarding the app’s end-user data practices are updated with complete transparency. Also, ensure that

• For AI-powered apps, ensure that the Category is selected as AI and select Yes for AI/GenAI question. Also, it is mandatory to indicate whether they comply with Freshwork's AI-powered features and Freddy AI terms. Once the app is published on the Freshworks marketplace, this will ensure that the app displays a Verified by Freshworks badge.

  Note: AI powered apps that are non-compliant with Freshwork's AI-powered features and Freddy AI terms will display a Not governed by Freshworks Freddy AI badge.

• If your app collects, processes, or stores end-user information, provide details on the information collected, processed, or stored, its purpose, and the countries where it is stored. The purpose for collecting, processing, or storing the data (for example, for ticket creation, summary generation, and so on) should be provided as a short description.

• If your app shares information with any third-party entities, ensure to provide the name and domain of the entity, countries where the entity stores the data, and the purpose for sharing the information. Up to five external domain URLs can be declared.

• Mention whether end-user information is encrypted both at rest and in transit, and specify if it can be accessed via app logs or exported.

• Acknowledge and specify if the app adheres to Open Web Application Security Project (OWASP) security standards.

• Mention whether the app transfers European Economic Area (EEA) residents’s End-User Data outside of the EEA and mention the transfer mechanism that governs those transfers.

• Confirm whether the app permanently deletes end-user data automatically on app uninstallation. If the app data is not deleted, share details of the retention period, specifying a range from minimum to maximum days.

• Confirm if your app allows customers to request for a custom data retention period.

This tab displays a table where the Keys column lists the keys present in the app_settings.json file of the app, and the Secrets column represents the values for those keys.

Configure values for the app settings based on the following cases:

• New Freshworks app: Add values for the corresponding keys in the Secrets column, and click Save and Publish to submit the app for the approval process.

• Existing Freshworks app: To update the app settings values of an existing Freshworks app that uses the app settings functionality,

  1. Edit the existing values for the corresponding keys in the Secrets column.

  2. Click Validate. The Validate button runs logic written in the onSettingsUpdate method of the app to validate the entered values.

     Upon successful validation, a prompt is displayed to publish the app settings.

     Publish App settings

  3. Click Publish Settings to publish the app settings.