Registering the app

Requested a Developer Sandbox account? Ready with your app? Find out how to register your app and send it off for the app approval process.


How to find the Marketplace Manager


First, go to the Settings page by choosing Tools and integrations from the drop-down menu:

25682568

Then choose Marketplace Manager in the left menu:

25622562

You must have a Developer Sandbox account for app creation to see Marketplace Manager



Register a new app


To register a new app, click on the green “Create new app” button. This is also where you’d see a list of your registered apps if you have any.

19001900

Intent to publish app on Pipedrive's Marketplace


When you click on the “Create new app” button, you’ll be brought to the “Intent to publish app on Pipedrive's marketplace” screen. This is where you choose the kind of app you will be creating: a public app or a private/unlisted app. Learn more about types of apps here.

20102010

The "Intent to publish app on Pipedrive's Marketplace" screen

On our side, we will receive a notification when you send your app for review, so we know which type of app we are reviewing. Learn more about our app approval process here.


App registration form


This is what the beginning of the form you need to fill in looks like. Here, we've pointed out the two required fields to create the app - the App name and the OAuth Callback URL. Other fields marked as required will be validated when you're sending your app to review.

📘

Disclaimer: The Marketplace team reserves the right to make small changes to text fields and images uploaded to the app's listing in order to give the best possible user experience. You'll be notified when something is edited.

10581058

App registration form

This is how your app’s info from the Marketplace Manager will be converted to the app listing page in the Marketplace.

18161816

Example app listing

General information

Field

Description

App name (required)

Insert your app's name by what it's going to be recognized in the Marketplace.

Example: Random

Company

This name will appear publicly on the Pipedrive Marketplace.
It should be the name of the company responsible for developing the app.
To change the company name click “edit” under the company name, you'll be taken to Company settings.

Example: Random Inc

Short summary (required)

Summarize the essence of what your app does. It will be shown in the list views and other places where the full description cannot be shown in the Marketplace.

Example: Awesome random app that will help you to manage your tasks and the workflow better

Description (required)

Clearly state what your app does and why the integration with Pipedrive is useful. It needs to be unique text specifically tailored for the Pipedrive Marketplace to avoid being marked as double content by search engines.

Example: Discover this awesome app that will help to manage your tasks in Pipedrive by motivating you not to procrastinate! The Random app has received many excellent user reviews, among them Quinn Smith's feedback:
"It feels so empowering to actually have control over my work!"

Categories (required)

Choose max two categories from the drop-down menu which best represent your app's use case.

Example: Task and workflow management

App icon (required)

Upload an icon that represents your app the best (be aware of the file type and sizing requirements).

Icon criteria:

  • PNG, JPG
  • 1:1 aspect ratio
  • min 256x256 px
  • max 10 MB
  • YouTube video link (one link)

    Add a link to a video that depicts the capabilities of your app with a specific demonstration of how it works together with Pipedrive. We recommend you use the video to market your app.

    We currently support only Youtube video links.

    App listing images (1 required, max 5)

    Upload max 5 images which should be helpful to users by illustrating how the app works, highlighting key areas and demonstrating the general flow process.

    Image criteria:

  • PNG, JPG
  • 16:10 aspect ratio
  • max 10 MB
  • 1280x800, 1440x900, 2560x1600 or 2880x1800 pixels - the bigger the better!
  • OAuth and Access scopes

    Field

    Description

    Callback URL (required, one URL per app)

    Insert a link where an authorization code will be sent if the user approves or declines the installation of your app. This link is also where we return the user to after successful authentication.

    Technically, a callback URL is the same thing as an OAuth redirect_uri. It's ok to insert a non-functioning URL when creating a new app as long as you can update this field with a proper URL after implementing the logic needed for accepting user authorization in your code.

    Please keep in mind that we allow only one callback URL per app.
    Example: https://www.randomawesomeapp.com/API/v2/callback

    Access scopes (required)

    By using scopes, you can specify exactly what kind of data access your application needs. Your selection will depend a lot on the endpoints you end up using in your app.

    Start by choosing the least amount of scopes possible. Then, based on the endpoints you use in your code, enable additional scopes according to this mapping.
    Example:
    :white-check-mark: Search for all data
    :white-check-mark: Read users data

    🚧

    The user has the option to either accept or deny all scopes. Because of this, it's a good idea to build apps that only request scopes that are absolutely necessary for your particular use case.

    App extensions

    App actions - Link actions
    Learn more here.

    Field

    Description

    Action name (required)

    Insert your app action's name that will be displayed in the Pipedrive UI. The name should be short, descriptive of the app action, and be in a sentence case format.

    Example: Send quote - Car Services

    Action description

    To showcase the interactive features of your app, your action’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 with this action.

    Optional; max 150 characters.

    URL link (required)

    Add the URL that will redirect the user to the correct app page when an action is clicked. The URL must handle both scenarios of the user being logged into your app and not being logged in.

    Example: https://www.randomawesomeapp.com/handle_action

    JWT secret

    If left empty, client_secret will be used by default.

    Locations (one required)

    Specify in which views the app action will be displayed. There can be a maximum of 3 app actions per app or custom modals in one view, altogether 21 (7 different views x 3 actions per view).

    Example:
    :white-check-mark: Activities list
    :white-check-mark: Person details

    App actions - JSON modals
    Learn more here.

    Field

    Description

    Action name (required)

    The name of the JSON modal. The name should be short (max 30 characters), actionable, and sentence-cased (only capitalize the first word).

    Example: + Prod. details - Car Services

    Action description

    To showcase the interactive features of your app, your action’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 with this action.

    Optional; max 150 characters.

    API endpoint (required)

    All API requests related to this action will be sent to this URL.

    Example: https://www.randomawesomeapp.com/handle_action

    JWT secret

    If left empty, client_secret will be used by default.

    JSON schema (required)

    The JSON schema for your JSON modal.

    Locations (one required)

    There can be a maximum of 3 app actions or custom modals per location. Each app can have a total of 21 app actions.

    See more about available locations in app actions' visibility.

    Example: Deal details

    JSON panels
    Learn more here.

    Field

    Description

    Panel name (required)

    Insert your JSON panel's name that will be displayed in the Pipedrive UI. The JSON panel's name should be descriptive and maximum of 30 characters.

    Example: Car PM - Car Services

    Panel description

    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.

    API Endpoint (required)

    The URL of the endpoint which we'll use to fetch the data of the object properties

    Example: www.api.pipedrive.com/deal-view/visits

    HTTP Auth username (required) and HTTP Auth password (required)

    Our service will send the HTTP request with these credentials as the Basic Authentication header to protect your data. To protect your data, we strongly recommend using authenticated HTTPS requests. Note that we do not support self-signed certificates.

    JWT secret

    JWT is required if HTTP Auth is not provided.

    JSON data structure (required)

    A JSON file that describes the structure of your JSON panel as seen in the Pipedrive UI. See here for more information.

    Panel locations (one required)

    Choose where the panel would be displayed:

    • Deal details
    • Person details
    • Organization details

    Each app can have one JSON or custom panel in each location.

    Custom panels
    Learn more here.

    Field

    Description

    Panel name (required)

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

    Panel description

    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

    • Please ensure your iframe URL uses HTTPS

      JWT secret

      Optional. Defaults toclient secret.

      Panel locations (one required)

      Choose where the custom panel will be displayed:

      • Deals details view
      • People details view
      • Organizations details view

      Each app can have one custom or JSON panel in each location.

      Custom modals
      Learn more here.

      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.

      Settings

      Learn more here.

      Field

      Description

      Type

      Choose how you want your app's user to access their app settings

      • External link
      • Custom UI

      URL (required) - for External link

      Add the URL that will redirect the user to your app settings page

      Iframe URL (required) - for Custom UI

      URL of the web content to be shown within the iframe

      • Please ensure your iframe URL uses HTTPS

      JWT Secret - for Custom UI

      Optional. Defaults toclient secret.

      Setup and installation

      Field

      Description

      Instructions for users (max 1500 characters)

      Remember to give helpful step-by-step instructions to existing customers and newcomers who will set up the integration from scratch.
      This will help newcomers to understand the level of effort required to install and use your app, for example, the first step could be creating an account at your service.

      Support and legal info

      Field

      Description

      Website URL (required)

      Insert a link to your app's website.

      Example:
      https://www.randomawesomeapp.com

      Terms of Service URL (required)

      Insert a link to your app's Terms of Service webpage with rules that users must agree to abide by to use your service/app.

      Example: https://www.randomawesomeapp.com/rules

      Privacy Policy URL (required)

      Insert a link to your app's Privacy Policy webpage of a legal document that has most or all the information of how user's data is gathered, used, communicated and managed.

      Example: https://www.randomawesomeapp.com/help/privacypolicy

      Support URL

      Insert a link to your app's Support website's main page, where a user with questions/problems can find answers about: different support channels and their SLAs, FAQs, self-service support resources, maybe even discover tips and tricks about your app, or get general help.

      Example: https://www.randomawesomeapp.com/support

      Support email

      Insert an email address for your app's Support contact if the user needs direct help.

      Example: [email protected]

      Documentation URL

      Insert a link to your app's documentation website from where the user can familiarize oneself with your app's features: a detailed description of what your app can do and how, tutorials/articles for getting started or specific use cases, etc.

      Example: https://www.randomawesomeapp.com/help

      Issue tracker URL

      Insert a link to your issue tracker website, where users could go and report bugs or any other issues noticed when using your app.

      Example: https://gitzhubz.com/randomawesomeapp/issues

      Your contact info

      Field

      Description

      Main contact email (required)

      The main point of contact to receive technical updates and notifications from Pipedrive.
      You can switch the toggle to green and agree to receive notifications about new, edited or deleted reviews.

      Before sending to review

      Field

      Description

      Installation scenarios are tested (required)

      A user does not have an account with you and installs the app
      (Installation runs through the process of creating an account and finishes the app install)

      A user does have an account with you, but isn't logged in and installs the app
      (Installation runs through login on your side and finished the app install)

      A user has an account with you, is logged in, and install the app
      (Installation recognizes the user is logged in and finishes the app install)

      Find out more about app installation flows here.

      Pipedrive Developer Partner Agreement (required)

      I agree to the terms and conditions of the Pipedrive Developer Partner Agreement
      (It covers details about leaving a review for your own app, the privacy of the Customer Data, app approval process and more)



      Save your app


      When you've filled in the form, click on the green "Save" button and save your app.

      15061506

      After saving, your app will be hidden by default and you'll see your app's status next to the app name.
      Your app will be assigned a unique client_id and client_secret, which can be seen on the app listing's edit page in OAuth & Access scopes section. These values are necessary to go through authorization and receive the access_token to be used in API requests.

      15481548

      🚧

      To be published on the Marketplace, your app needs to pass our app approval process.
      Note that submitting the app is not necessary if it's only used within your Pipedrive company account.



      Did this page help you?