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:

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:

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:
Search for all data
Read users data

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:
Activities list
Person details

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

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.

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.

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.

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.

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.

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

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.

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)