Pipedrive API Documentation

Pipedrive's API Docs

Welcome to Pipedrive's Developer Documentation. Here you'll find comprehensive guides and documentation to help you start working with Pipedrive's API, as well as the Changelog to see any relevant changes regarding the public API.

Actions in panels

Terminology


App panels - An entrance point for an app's data and interactivity inside Pipedrive in a panel format.

Object - App panel object is a data entry point with multiple descriptive fields displayed inside a panel. A panel can contain multiple objects.

Object actions menu - A white "Actions" button with an arrow pointing downwards at the top right of the object. It features a dropdown menu that gives access to a basic or embedded app action(s). Object actions are specific to the object itself and only available for multiple object panels.

Field - Descriptive data field in a certain format within the object.

Field action - A basic or embedded action that allows the user to interact with the data inside the field. The action is specific to the field itself.

Global actions - A green action button at the bottom of the app panel. It features one primary app action and a dropdown menu if there are multiple app actions and/or an external link.

Actions menu - A dropdown menu, accessible from the three dots symbol on the top of the panel. The menu allows the user to manage the left sidebar, adjust panel and app settings as well as access the same app action(s) as the one(s) defined in global actions.


What are actions in panels?


Actions in panels allow you to add interactivity to different aspects of your app panel:

  • Global actions - app actions for the entire panel that is specific to the details view that the user is in (Deal, People, Organization),
  • Object actions - app actions for the object itself and only available for multiple object panels,
  • Field actions - app actions for individual fields.

Global actions

Global actions in the app panel

Global actions in the app panel

Found at the bottom left of the app panel, global actions are represented by a green action button that is unique to app panels. This is where you can add one primary app action to be featured and two additional app actions that will be included in the global actions dropdown menu. You can have a maximum of 3 app actions within global actions.

The global action can be a basic or an embedded app action. This means you can use basic app actions to initiate an action from Pipedrive that will be completed in your app or use embedded app actions to allow users to complete full actions in Pipedrive using an interactive component (a modal).

You can also add an additional external link to global actions by extending the API response with an external link object.

Object actions

Object actions

Object actions

You can add a maximum of 3 basic or embedded app actions that are specific to the object itself. Object actions are available at the top right of each object through a white "Actions" button with an arrow pointing downwards that features a dropdown menu. Object actions are universal for every object and only available for multiple object panels.

Field actions

Field actions

Field actions

Within each object are fields that display descriptive data in a certain format. You can add one basic or embedded app action to a field to allow users to interact with the data inside it. Each panel object can have a maximum of 3 fields with actions.


Steps for adding an action


Actions in panels can be added in the App Extensions section of the Marketplace Manager:

  • Global actions are added via App actions
  • Object and field actions are added via App panels > Panel actions section > + Add actions to this panel

How to add global actions

Adding global actions to your panel is the same as adding a basic app action or an embedded app action. You can have a maximum of 3 app actions within global actions.

Basic action - global action

A basic global action will reroute users from Pipedrive to your app to complete the relevant action.

Field
Description

Action name (required)

Max 30 characters, in sentence-case

Action type

Basic action

URL (required)

The URL that handles the action in your app

Locations

The location where the action will be displayed in Pipedrive UI

Embedded action - global action

An embedded global action allows users to complete actions with Pipedrive using an interactive component - modal.

Field
Description

Action name (required)

Max 30 characters, in sentence-case

Action type

Embedded action

API endpoint (required)

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

JWT secret

If left empty, client_secret will be used by default.

JSON data structure (required)

The JSON schema for your Embedded action.

Locations

The location where the action will be displayed in Pipedrive UI

How to customize the order of global actions

By default, global actions are ordered by their creation timestamp and the newest one will be shown as the primary action. This means that the last app action that is saved (newest) will be the primary action while the subsequent two app actions you added before will be included in the dropdown menu.

We are currently working on a solution for you to select the primary action for global actions.

How to add object actions and field actions

You will be able to add object and field actions when you’ve added a JSON schema that defines your app panel's structure and saved it. Both object and field actions can be a basic app action or an embedded app action.

  • Object actions are only available for multiple object panels, with a maximum of 3 basic or embedded app actions.
  • Field actions are available for both single object and multiple object panels, with one basic or embedded app action added to a field to allow users to interact with the data inside it. Each panel object can have a maximum of 3 fields with actions.

Basic action - objects and fields

A basic object action and a basic field action will reroute users from Pipedrive to your app to complete the relevant action. Adding a basic app action for objects and fields is the same.

Field
Description

Action name (required)

Max 30 characters, in sentence-case

Action type

Basic action

URL (required)

The URL that handles the action in your app

Action target

The location where the basic app action will be displayed:

  • Object - the action is universal for every object in your panel
  • Field - the action is specific to the selected field

Embedded action - objects and fields

An embedded object action and an embedded field action allow users to complete full actions in Pipedrive using an interactive component - modal. Adding an embedded app action for objects and fields is the same.

Field
Description

Action name (required)

Max 30 characters, in sentence-case

Action type

Embedded action

API endpoint (required)

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

JWT secret

If left empty, client_secret will be used by default.

JSON data structure (required)

The JSON schema for your Embedded action.

Action target

The location where the embedded app action will be displayed:

  • Object - the action is universal for every object in your panel
  • Field - the action is specific to the selected field


Troubleshooting


As there are only two types of app actions - basic and embedded, troubleshooting for actions in panels is the same as troubleshooting for these actions.

Updated 22 days ago


Actions in panels


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.