Configure app manifest, subscribe to events, and register callback

After creating a serverless app’s files, to configure the app manifest, from the app’s root directory, navigate to manifest.json.

App manifest attributes - description and how to configure them

  • platform-versionstring

    Platform version you use to build the app. This value is auto-generated when you create the default app files by using the fdk create command.

    When you build a new app, ensure that you are on the latest version of the platform . If you update your existing app that was built with an earlier platform version, ensure to move to the latest version of the platform. For migration steps, see Migration guide.

  • productobjectRequired

    Associates a Freshworks product with the information that is necessary to render the app on the specified product.

  • enginesobject

    Node.js and FDK versions that are used to build the app. When you create the front-end app files by using the fdk create command, this attribute value is auto-populated.

    Creating an app: If you use FDK 7.0.0 or later versions to create an app, the engines attribute is available by default as part of the manifest.json file.

    Migrating an app: If you have an existing app that is built using FDK 6.x.x or an earlier version, ensure to,

    1. Install the latest FDK version.
    2. Run fdk validate to migrate the app to the latest FDK version. As part of this process, the FDK updates the engines attribute.
    3. Retest the app.
  • dependenciesobject

    All npm packages that the app uses, specified as <npm-package-name>:<version> pairs.


    This attribute is not a default attribute. If your app uses npm packages, in manifest.json, include this dependencies attribute and register the packages as dependencies.