Open a sidebar plugin from a URL

You can open a sidebar plugin from a URL in a Front message or comment using the following format:

https://<Front base domain>/open-sidebar-plugin/<App UID>

The Front base domain is typically app.frontapp.com and the App UID can be found in the Basic info tab of the application that contains the plugin you are opening. The URL will only open a plugin if it is clicked from a Front message or comment (will not work if linked from an external website) and will only open plugins that were created in the same instance of Front where the link is supplied.

The URL can be added manually into messages or comments or through the API via the Create message, Create message reply, Create draft, Create draft reply, Edit draft, Add comment, and Update comment endpoints. If you create a link through a comment programmatically, you can use Markdown formatting to make it more human readable, such as [Open sales tool](https://app.frontapp.com/open-sidebar-plugin/40a4eae201a760d1).

📘

Opening a sidebar plugin from a URL only works with the current version of the Plugin SDK. It does not work for the legacy plugin SDK.

Example

https://app.frontapp.com/open-sidebar-plugin/40a4eae201a760d1

Passing custom properties

One of the benefits of opening a plugin from a URL is that you can also pass custom properties to the Plugin SDK Context. You do this by adding query string parameters:

https://app.frontapp.com/open-sidebar-plugin/40a4eae201a760d1?propertyA=DoubleR&propertyB=true&propertyC=777

The properties become available in the customContextProperties object in the EntryPoint of the plugin context.

📘

All properties will be mapped as strings

"entryPoint": {
    "type": "URL",
    "data": {
      "customContextProperties": {
        "propertyA": "DoubleR",
        "propertyB": "true",
        "propertyC": "777"
      }
    }
  }