Once your app is built and tested, you can submit it to make it available to users through the Freshworks Marketplace.
You can submit your app under one of the following types:
- Freshworks app: Publicly available to all Freshworks customers through the Marketplace.
- Custom app: Private and available only to a specific Freshworks account or customer.
- External app: Listed and distributed through an external website or platform.
- You can submit only Custom apps directly through the Freddy AI Copilot for Developers panel in Visual Studio Code.
- To submit your app as a Freshworks app or an External app, follow the detailed submission guides:
Prepare the app for submission
Before submitting your app, use Freddy AI to generate documentation, update test coverage, and finalize your code for release.
Follow these steps in your app project to prepare the app for submission.
Generate documentation
Select the relevant code block in your project.
Right-click and select Freddy: Generate documentation.
Freddy creates or updates markdown files with feature summaries and API references.
Generate or update unit tests
Select the relevant code block.
Right-click and choose Freddy: Generate unit test.
Freddy creates new unit tests or expands existing test coverage for your recent changes.
Finalize the changes
- Review the generated documentation and test files.
- Make any final edits needed to ensure accuracy and completeness.
- Commit your changes to version control.
- Proceed to publish the app when you are satisfied with the updates.
Best practice:Keep documentation and unit tests up to date after every major feature addition or code change to maintain app quality and consistency.
Submit a new Custom app
Package and submit the app
- Open the Freddy AI Copilot for Developers panel in Visual Studio Code.
- Click the "Pack and Publish" icon.
- When prompted, select New App.
- Enter the required app details:
- App name
- App overview
- App description
- Support email
- Alternate email
- Click Publish.
Verify the app submission
- Sign in to your Developer Account.
- Confirm that a new app entry is created with the specified app name and description.
Install and test the app
- Sign in to your product account.
- Navigate to Neo Marketplace > Marketplace Apps > Manage Apps.
- Open the In Development section.
- Locate the app and click Install.
- Navigate to the page where the app is expected to appear.
- Append ?dev=true to the page URL to load the development version of the app.
- Verify the app behavior to ensure it functions correctly.
Publish the app
After successful verification:
- Return to your Developer Account.
- Open the app entry.
- Click Save and Publish to publish the app as a Custom app.
Submit a new version of an existing Custom app
Package and submit the updated app
- Open your app project in Visual Studio Code.
- Make the required changes to the app code.
- Open the Freddy AI Copilot for Developers panel and click "Pack and Publish" icon.
- Wait for the confirmation message “App Published Successfully!” to appear in the panel.
Verify the test version
- Sign in to your Developer Account.
- Open the app and verify that a new test version appears under the Versions section.
Install and test the updated version
- Sign in to your product account.
- Navigate to Neo Marketplace > Marketplace Apps > Manage Apps.
- Open the In Development section.
- Locate the app, apply the update, and click Install.
- Navigate to the page where the app appears.
- Append ?dev=true to the page URL to load the development version.
- Verify the app behavior to ensure it functions as expected.
Promote the app to live
- In your Developer Account, navigate to the published app on AMP.
- Click Promote to Live below the app package.
- When prompted, click Continue to Publish.
- Wait for the success notification and confirm that the app status changes to Published.
Install the live version
- Return to your product account.
- Navigate to Neo Marketplace > Marketplace Apps > Manage Apps.
- Open the Custom Apps section.
- Install the published version of the app.
- Verify the app deployment again, this time without appending ?dev=true to the URL.
Best practice:Always validate the app thoroughly in the development environment before promoting it to live to avoid impacting end users.