Actions in JSON panels

📘

JSON panels were previously called app 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 link(s) or JSON modal(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 link or JSON modal 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 main app action and a dropdown menu if there are multiple app actions and/or an external link. Global actions are app actions available for the whole app that is specific to the detail view that the user is in (Deal, People, Organization).

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

Global actions in the app panelGlobal actions in the app panel

Global actions in the app panel

Global actions are app actions for the entire app panel that is specific to the detail view that the user is in (Deal, People, Organization). As your JSON panel can be in three detail views altogether, you have the option of customizing global actions for each app panel in each of the detail view.

Represented by a green action button that is unique to app panels, global actions can be found at the bottom left of the app panel. This is where you can add one main 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 app action within global actions can be a link or a JSON modal. This means you can use

  • Links to reroute users from Pipedrive to an external page hosted by your app to complete an action.
  • JSON modals 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 actionsObject actions

Object actions

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. You can add a maximum of 3 link or JSON modal app actions that are specific to the object itself. Object actions are universal for every object and only available for multiple object panels.

Field actions

Field actionsField actions

Field actions

Within each object are fields that display descriptive data in a certain format. You can add one link or JSON modal 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 link or a JSON modal. You can have a maximum of 3 app actions within global actions.

Link - global action

A link 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

Link

URL (required)

The URL that handles the action in your app

Locations

The location where the action will be displayed in Pipedrive UI

JSON modal - global action

A JSON modal 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

JSON modal

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 JSON modal.

Locations

The location where the action will be displayed in Pipedrive UI

How to customize the order of global actions

Global actions at the bottom left of the app panelGlobal actions at the bottom left of the app panel

Global actions at the bottom left of the app panel

By default, global actions are ordered by their creation timestamp and the newest one will be shown as the main action. This means that the last app action that is saved (newest) will be the main action in the green button of global actions, while the subsequent two app actions you added before will be included in the dropdown menu. See how it looks like here.

Selecting the main action for global actions
In Marketplace Manager, a new field with a dropdown menu will appear when you have specified your app panel's location(s). You can then select the app action you want from the dropdown menu as the main action for the global actions green button.

Main action for global actions field with a dropdown boxMain action for global actions field with a dropdown box

Main action for global actions field with a dropdown box

Do take note that app actions will only appear in the main action dropdown menu if you chose the corresponding detail view for the app action in the App actions section of Marketplace Manager.

  • For example, if you want the app action "Add new order" to be the main action for global actions in Deal details, ensure that Deal details is selected as a location for the app action itself.
Ensure you've selected the corresponding details view for the app action you want as the main action in global actionsEnsure you've selected the corresponding details view for the app action you want as the main action in global actions

Ensure you've selected the corresponding details view for the app action you want as the main action in global actions

Should you want to use the same app action as the main action for all global action, ensure that all three details views (Deal, Person, Organization) are selected for the app action.

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 link or a JSON modal.

  • Object actions are only available for multiple object panels, with a maximum of 3 link or JSON modal app actions.

  • Field actions are available for both single object and multiple object panels, with one link or JSON modal 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.

Link - objects and fields

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

Field

Description

Action name (required)

Max 30 characters, in sentence-case

Action type

Link

URL (required)

The URL that handles the action in your app

Action target

The location where the link will be displayed:

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

JSON modal - objects and fields

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

Field

Description

Action name (required)

Max 30 characters, in sentence-case

Action type

JSON modal

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 JSON modal.

Action target

The location where the JSON modal 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 - [link(doc:app-extensions-actions) and JSON modal, troubleshooting for actions in panels is the same as troubleshooting for these actions.



Did this page help you?