The common module

FAQs

Your app use case is not product specific. You want to build an app that works across all Freshworks products. Which module should you consider building for?

You can build your app to work for the common module. All app building capabilities (such as placeholders and serverless events) and interfaces that are not module-specific are offered as part of the common module. For detailed information on how to use the common module, see the common module introduction.

You want to use the common module app capabilities (such as, the full-page app placeholder) and build a module/product-specific app. Is it possible?

Yes. We do not place restrictions on the number of modules you can add to your app manifest. To manifest.json, add a module and place your module-specific app parameters in the module attribute and non-module specific parameters in the common attribute. The common module is used to,

  • Declare common placeholders.
  • Configure all common serverless events such as App set-up events, External events, and Scheduled events that your module-specific app uses.
  • Declare request templates, if your app uses the templated request method to place secure HTTP calls.
  • Register SMI functions, if you are building a full-stack SMI app.

Are there any caveats around the use of the common module?

There are some important guidelines to keep in mind when using the common module. For instance, in your app manifest, it is mandatory to have at least one module in addition to the common module. If you have no module-specific logic in your app, this other module in the manifest can be an empty object. For an exhaustive list of all the guidelines, see the common module introduction.