Custom UI extensions is currently in BETA. As this feature is still in development, it's subject to change. Please send your feedback to [email protected].
NB: Please ensure you test this feature on a draft app, not an approved/public one.
A custom panel is an iframe that’s embedded inside a sidebar panel.
Just like JSON panels, custom panels are found as a panel in the left sidebar section inside the detail view of Deals, People, and Organizations.
Each app can have only 1 custom or JSON panel per detail view. This means each app can have 3 different panels (custom or JSON) altogether - 1 for each detail view (Deal, People, and Organization).
The custom panel will appear at the top of the left sidebar section. Users can change, hide, and reorder their location with other sections in the sidebar.
Go to your app’s edit page in Marketplace Manager and scroll to App extensions > Custom UI extensions > Custom panel. Click on “+ Custom panel” and fill in the following fields:
Panel name (required)
The name of your custom panel. Descriptive, max 30 characters and should be sentence-cased (only capitalize the first word).
To showcase the interactive features of your app, your panel’s name and description will appear in the Features section of your Marketplace app listing.
Use the description field to let users know what they can do within this panel.
Optional; max 150 characters.
Iframe URL (required)
URL of the web content to be shown within the iframe
Optional. Defaults to
Panel locations (one required)
Choose where the custom panel will be displayed:
Each app can have one custom or JSON panel in each location.
NB: If your app already has a JSON panel for a specific detail view, that particular detail view will be disabled from Panel locations in Marketplace Manager.
Note: The app has to be installed by the user in order for them to be able to use custom UI extensions.
A custom app surface is dependent on the iframe URL you provide in Marketplace Manager.
A custom panel is dependent on the iframe URL provided in Marketplace Manager. If users can’t see the panel’s content, this could mean:
- The web content failed to load
- The runtime
idprovided was wrong
- The SDK wasn’t initialized
Please check the iframe URL you provided, along with its frontend and backend capabilities, and the runtime
id provided to the SDK.
Updated 21 days ago