Freshworks apps

Important:Before submitting an app in the Developer portal, to facilitate quick review and publishing, ensure that the app meets the content and code review guidelines.

The Freshworks’ app submission process enables you to,

For a Freshworks app, after a new version is reviewed and published, it is available for app users, if they want to update their existing app.

The developer platform’s What’s New feature,

  • Enables you to provide a What’s New/Release Notes write-up, when submitting a new version of an app. For information on how to include Release Notes when uploading a new version of the app, see Upload and submit a new version of an existing Freshworks app.
  • Helps app users understand the enhancements in the new version. When app users view the list of installed apps, if a new version of the app is available, a What’s New link is displayed along with the 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 (Admin Settings > Marketplace for Chat), select an app card, and view the app details.

After your app is deployed, you can measure your apps usability and engage with your app users, through the App insights provision. For more information, see View app insights.

Upload and submit a new Freshworks app

  1. Log in to your Freshchat account and from the left navigation pane, navigate to apps gallery (Admin Settings > Marketplace for Chat). The Apps gallery is displayed.

  2. Click Go to Developer Portal. The All Apps page is displayed.

  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. Click Proceed. A page for entering the app details is displayed and the Supported Product field is auto-populated as Freshchat.

    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. Built for: The product for which the app is built.
    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).
    App draft versionDraft version of the app
  7. To replace the uploaded app, in the Code File section, click the replace icon.

    Replace draft versionReplace draft version of the app

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

  8. In the main section of the app details page, navigate to the App information tab and update the requisite app details.

  9. 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.

  10. To save the app details, click Save.

  11. 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 sectionCode file section

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

After app approval

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).

Live appLive app in Code file section

Provide selective access

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.freshchat.com

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

    App sharing settingsSharable URL for selective access

View app insights

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

Ratings and Reviews

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, Image of rate count is the count of the number of users who have rated the app and Image of installation count is the number of app installations, currently.

Ratings reviewApp insights for published apps

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.Review responseRatings 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.

Uninstall Feedback

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

App insightUninstall feedbacks

After app rejection

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.

App rejected draftRejected app in Code file section
  • 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).

Upload and submit a new version of an existing Freshworks app

  1. Navigate to (Admin Settings > Marketplace for Chat) and 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.
  2. In the Code File section, click Add new version. The Add new version window is displayed.
  3. 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 versionAdd new version window
  4. 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.
  5. 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.Warning promptEdit button with a promt to add the release notes
  6. In the main section of the app details page, navigate to the App information tab and update the requisite app details.
  7. 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.
  8. To save the app details, click Save.
  9. 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.
  10. 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 (Admin Settings > Marketplace for Chat), 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.

App information tab

The app information to be displayed in the Freshworks Marketplace are captured in the following sections:

Notes:
  • To view the sample rendering of app details in the Freshworks Marketplace, navigate to each section and click Show Example.
  • For more information on the Freshworks app building and submission process, refer to the video tutorials, support articles, and FAQ’s in the Help section.

App Display Details

FieldDescription
App Name MandatoryEnter a name for the app, comprising two to three words.
App Overview MandatoryEnter an introduction to the app, not exceeding 100 characters.
Short DescriptionEnter a brief description of the app’s functionality and features.
App Description MandatoryEnter a description stating the value that the app imparts to Freshchat. Mention any specific use case necessary to support the value proposition.
Installation InstructionsWhen the app is installed, if specific user actions are required, enter the instructions as a sequential list.
App Category MandatorySelect the appropriate category to help users filter and find the app in the Marketplace gallery. You can select a maximum of two categories.

Media

FieldDescription
App icon MandatoryUpload an icon to represent the app. Ensure that the logo meets the following requirements.
  • Image format is PNG.
  • Logo background is transparent.
  • Aspect ratio is 1:1.
  • Minimum resolution is 400 x 400 pixels.

App Screenshots Mandatory

Upload screenshots to the Common section to illustrate how the app works. Capture different states and process flows to give users a better insight into the app. You can upload a maximum of five screenshots.

Ensure that the screenshots meet the following requirements.

  • Image format is PNG or JPG.
  • Minimum resolution is 1600 x 1000 pixels.

Video Link Mandatory

Enter the URL to the YouTube or Vimeo video that explains the app’s use case. The URL should be in the following format:

  • YouTube link - https://youtu.be/VIDEO_ID
  • Vimeo link - https://player.vimeo.com/video/VIDEO_ID

For more information on the guidelines, see Video link.

Support Details

FieldDescription
App Specification / Demo Video MandatoryEnter the URL to the app’s specification document or demo video.
Support Email MandatoryEnter the email address that users can use to contact you in case of any queries regarding the app.
Support URL MandatoryEnter the URL to any location where users can find more information about the app.
Alternate Email MandatoryEnter the email address that Freshworks can use to contact you, when the app is under review.
Privacy policy URL MandatoryEnter the URL to the app’s privacy policy that clearly states the mechanism followed by the app when handling user information.
Terms of Service URL
Mandatory
Enter the URL to the Terms of Service/Use that apply to the app user, when using the app.
Hide from gallerySet the toggle key to on state, to hide the app from the Marketplace apps gallery. After the app is published successfully, in the app details page, an App Sharing Settings section is displayed. This section facilitates generating a shareable link for your app and enables you to provide selective access to your app.