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 modal is an iframe embedded in a modal. The modal opens when a user triggers it from various menus and links inside Pipedrive.
With custom modals, you have the opportunity to allow your app’s users to complete more complex and distinct actions, for example, creating new proposals/invoices.
Custom modals VS custom panels
Inside Pipedrive’s UI
Here are the possible entry points in Pipedrive’s UI where a custom modal can be triggered from:
A custom modal from the actions menu
Custom modals in list views will only appear when an item(s) is selected. Custom modals will pop up when the user clicks on its name in the actions menu in the detail and list views.
Each app is allowed to have 3 custom/JSON modals or link actions per view. This means an app can have a total of 21 app extensions from menus (7 possible views x 3 extensions).
Custom modals can be triggered from app settings with a custom UI via the SDK. App settings can be found in the Pipedrive web app via Tools and apps > Marketplace apps.
If you would like to add a custom UI for your app’s settings, please click here.
Go to your app’s edit page in Marketplace Manager and scroll to App extensions > Custom UI extensions > Custom modal. Click on “+ Custom modal” and fill in the following fields:
Modal name (required)
The name of your custom modal. Descriptive, max 30 characters and should be sentence-cased (only capitalize the first word).
To showcase the interactive features of your app, your modal’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 modal.
Optional; max 150 characters.
Iframe URL (required)
URL of the web content to be shown within the iframe
Optional. Defaults to
The custom modal will be shown as a link in the actions menu of the chosen entry point(s).
Choose the location(s) your custom modal can be triggered from:
If no entry points are selected, the only way to open a modal is via the SDK. Maximum 3 app extensions per location.
Each app can have a total of 21 custom/JSON modals or link actions.
To add a custom modal via the SDK and for custom panels and app settings, you will have to:
- Add a modal to Marketplace Manager using the same steps listed above.
- Leave the Entry point field blank
- Copy the ID
- Use the ID as the
action_idparameter for custom modal in the SDK
Note: The app has to be installed by the user in order for them to be able to use custom UI extensions.
A custom modal is dependent on the iframe URL provided in Marketplace Manager. If users can’t trigger the modal and/or see the modal’s content, this could mean:
- The web content failed to load
- The runtime
idprovided was wrong
- The SDK wasn’t initialized > if the iframe takes more than 10 seconds to initialize via our SDK, the iframe won't be displayed to the user.
Please check the iframe URL you provided, its frontend and backend capabilities, and the runtime
id provided to the SDK.
Should you encounter any SDK errors, please read the developer tools console to find out what went wrong.
Updated about 2 months ago