Custom modals (BETA)

📘

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.

What is a custom modal?


Custom modal

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

Custom modal

Custom panel

Iframe

Yes

Yes

Size

  • Height and width are adjustable as a modal can have a bigger area.
  • Limited to the sidebar panel in Deal/Person/Organization detail view
  • Adjustable height

Inside Pipedrive’s UI

  • Multiple entry points including list and detail views as well as via the SDK
  • Take note that it will block content that’s beneath it
  • Deal/Person/Organization detail view
  • Appears as a panel within the detail view


Custom modals in Pipedrive’s UI


Custom modal

Here are the possible entry points in Pipedrive’s UI where a custom modal can be triggered from:

Custom modals in actions menus

Custom modal

A custom modal from the actions menu

Similar to app actions, entry points to custom modals can be added to the three-dot actions menu in the upper right area of both the detail and list views. 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 modals or app actions per view. This means an app can have a total of 21 app extensions from menus (7 possible views x 3 extensions).

Item

List view

Detail view

Deals

People

Organization

Activities

Custom modals in custom panels

Custom modals can be triggered from custom panels using the SDK.

Custom modals in app settings

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.

Custom modals via SDK

Custom modals can be triggered with the SDK's's open modal command by providing the modal id or name. Using the SDK, you can also pass any data to the modal that can be read from the URL parameters.


How can I add a custom modal in Marketplace Manager?


Custom modal

Adding a custom modal for actions menus

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:

Field

Description

Modal name (required)

The name of your custom modal. Descriptive, max 30 characters and should be sentence-cased (only capitalize the first word).

Modal description

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

  • Please ensure your iframe URL uses HTTPS

JWT secret

Optional. Defaults toclient secret.

Entry points

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:

  • Activities list
  • Deal details
  • Deals list
  • Person details
  • People list
  • Organization details
  • Organizations list

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 modals or app actions.

Adding a custom modal - custom panels, settings & via SDK

To add a custom modal via the SDK and for custom panels and app settings, you will have to:

  1. Add a modal to Marketplace Manager using the same steps listed above.
  2. Leave the Entry point field blank
  3. Copy the ID
  4. Use the ID as the action_id parameter for custom modal in the SDK


How to troubleshoot a custom modal


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 id provided 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.


How to troubleshoot SDK errors


Should you encounter any SDK errors, please read the developer tools console to find out what went wrong.


Did this page help you?