Custom UI for app settings (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.

Apps can define how they want their users to access their app's settings in the Pipedrive UI. We offer two options:

  • An external link with your app's settings interface that opens in a new browser tab
  • A fully customizable iframe surface within the Pipedrive Settings area
    • For smooth installation, you can redirect users here so they can configure their usage after successfully installing your app with this URL: https://{COMPANY_DOMAIN}.pipedrive.com/settings/marketplace/app/CLIENT_ID/app-settings.


Visibility in Pipedrive’s UI


Custom UI for app settings

App settings are represented by the actions icon that can be found in the Pipedrive web app via Tools and apps > Marketplace apps.

When a user clicks on the actions icon, a dropdown menu appears that contains either an external link to your app settings or an entry point to a custom UI with your app's settings.


How can I add a custom UI for Settings?


Custom UI for app settings

Go to your app’s edit page in Marketplace Manager and scroll to Settings. Click on “Custom UI” and fill in the following fields:

Field

Description

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.

You can use HTML, CSS or Javascript to create the custom user interface for your app's settings. You can also redirect users to your app's settings so that they can configure their usage after successfully installing your app by sending them to https://{COMPANY_DOMAIN}.pipedrive.com/settings/marketplace/app/CLIENT_ID/app-settings.


How to troubleshoot a custom UI for app settings


Note: The app has to be installed by the user in order for them to be able to use custom UI extensions.

A custom UI for app settings depends on the iframe URL provided in Marketplace Manager. If users can’t see the custom UI for app settings, 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.


Did this page help you?