Custom Apps

To submit a Custom app:

  1. In the Freshteam developer website, click Log in. The Login with your Freshteam account window is displayed.

  2. Enter your Freshteam account URL (for example, mycompany.freshteam.com) and click PROCEED. If you are not signed in to your Freshteam account, the login page is displayed. Enter your Freshteam account credentials and click SIGN IN. The freshworks developer page is displayed.

  3. Click +Add New App. The Add New App window is displayed.

  4. Click Custom App. The Custom App window is displayed.

  5. Click Upload app file, select the packed app file, and click Open. The My New App page is displayed.

  6. Under the App Details tab, provide appropriate information by using the following fields.

    Note: As custom apps are not subject to the app review process, you can choose not to upload an app specification/demo video or enter an alternate email address.


    FIELD TASK
    For Product Select freshteam.
    App Name
    Mandatory
    Enter a name for the app, comprising two to three words.
    Overview
    Mandatory
    Enter an introduction to the app, not exceeding 100 characters.
    Description
    Mandatory
    Enter a description of the app’s functionality and features.
    Instructions If specific user actions are required when the app is installed, in this field enter the corresponding instructions as a sequential list.
    App Icon Upload 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.
    Screenshots Upload screenshots 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.
    • Minimum resolution is 1350 x 850 pixels.
    App Category Select the appropriate category to help users filter and find the app. You can select a maximum of two categories.
    App Specification/Demo Video Enter the URL to the app's specification document or demo video, to help app reviewers understand the app's basic functionality.
    Support Email
    Mandatory
    Enter the email address that users can use to contact you in case of any queries regarding the app.
    Support URL Enter the URL to any location where users can find more information about the app.
    Alternate Email Enter the email address that Freshworks can use to contact you, when the app is under review.

  7. To replace the uploaded app file, in the Development Version widget, click Replace File, select a new packed app file, and click Open.

  8. Click Publish, to submit the app. The label of the Publish button changes to Publishing In Progress. Custom apps are not subject to the review process and are available for installation within 30 minutes of app submission. If you update the app and republish it, the changes are deployed within 30 minutes. After the app is successfully added or updated, the label of the button changes to Publish.

  9. To verify the status of a custom app:

    1. From the Apps drop-down list, select My Apps. The My Apps page is displayed with a list of all apps published from your Freshteam account. Custom apps are displayed as cards with a lock icon.

    2. Hover the cursor over the corresponding custom app card. If the custom app is successfully published, the card’s status is displayed as INTERNALLY PUBLISHED.

To install a custom app:

  1. Log into your Freshteam account and from the left-navigation pane, select the Admin icon. The Admin page is displayed.

  2. Navigate to Integrate with other Apps > Apps. The Apps page is displayed.

  3. Navigate to the MANAGE APPS > Custom Apps. A list of all custom apps that are successfully published is displayed.

  4. Click the Install next to the app that is to be installed.

    1. If the app requires third-party authentication, a corresponding window requesting for login credentials is displayed. Enter appropriate credentials and log in. The Authorize app window is displayed. Click Authorize.

    2. If the app requires input in the form of installation parameters, the Settings page is displayed with the list of installation parameters. Enter appropriate input values and click Install.