Freshworks Developer Docs | Include placeholders for app deployment

On the product UI, an app can be rendered in any of the locations that the module supports. This module supports rendering an app in common placeholders and module-specific placeholders.

To render an app in the common placeholder, in manifest.json > modules.common.location.<placeholder-name>, you can specify the placeholder in the product’s left-navigation pane where the app is eventually rendered.

To render an app in a module-specific placeholder, in manifest.json > modules.service_change.location.<placeholder-name>, you can specify the placeholder on a page where the app is eventually rendered.

Notes:

You can specify multiple placeholders in manifest.json > modules.
Freshworks product apps are supported only as web apps (and not as mobile apps).

This section provides information on all locations (and the placeholders in these locations) where an app can be rendered for the service_change module.

The app icon is displayed on the left navigation pane and when clicked, the app page occupies the entire viewport.

The placeholder can have only one active app at a time.

manifest.json

"modules": {
  "common": {
    "location": {
      "full_page_app": {
        "url": "myfirstapp.html",
        "icon": "logo.svg"
      }
    }
  }
}

Note:Ensure that the app icon's resolution is 64 x 64 pixels and the fill value is set to #FFF.

The app icon is displayed at the bottom-left corner. This location is allocated for an app that uses the Computer Telephony Integration (CTI) technology. The default width and height of the app are 360 pixels.

The placeholder can have only one active app at a time.

Note:The placeholder can have only one active app at a time. If the Freshworks product account has a native CTI app and a custom-built CTI app installed, then the native CTI app is given preference and will be displayed at the placeholder.

manifest.json

"modules": {
  "common": {
    "location": {
      "cti_global_sidebar": {
        "url": "myfirstapp.html",
        "icon": "logo.svg"
      }
    }
  }
}

Note:Ensure that the app icon's resolution is 64 x 64 pixels and the fill value is set to #FFF.

Tutorials

Sample apps

Guides

Blogs

Assist catalog

Events

Include placeholders for app deployment

Common placeholders

full_page_app

cti_global_sidebar

Freshservice - Change details page

change_sidebar

change_background

Freshservice - New change page

new_change_sidebar

new_change_background