> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipedrive integration

[Back to list of enterprise systems](https://koreai.mintlify.site/agent-platform/integrations/enterprise-systems.md)

Use the Pipedrive integration to manage deals, leads, people, organizations, products, activities, notes, files, and labels through Action Tools. It also provides triggers for new and updated records and for records matching Pipedrive filters.

| Authentication | Actions | Triggers |
| - | - | - |
| OAuth 2.0 | ([30](#supported-actions)) | ([14](#triggers)) |

## Supported actions

| Action | Use it to |
| - | - |
| [Add Follower](#add-follower) | Adds a follower to a deal, person, organization or product. |
| [Retrieve a Note](#retrieve-a-note) | Finds a note by ID. |
| [Create Note](#create-note) | Creates a new note. |
| [Add Labels to Person](#add-labels-to-person) | Adds existing labels to an existing person. |
| [Add Product to Deal](#add-product-to-deal) | Adds a product to a deal. |
| [Attach File](#attach-file) | Uploads a file and attaches it to a deal,person,organization,activity or product. |
| [Create Activity](#create-activity) | Creates a new activity. |
| [Update Activity](#update-activity) | Updates an existing activity. |
| [Create Deal](#create-deal) | Creates a new deal. |
| [Update Deal](#update-deal) | Updates an existing deal. |
| [Create Lead](#create-lead) | Creates a new lead. |
| [Update Lead](#update-lead) | Updates an existing lead. |
| [Create Organization](#create-organization) | Creates a new organization. |
| [Update Organization](#update-organization) | Updates an existing organization. |
| [Create Person](#create-person) | Creates a new person. |
| [Update Person](#update-person) | Updates an existing person. |
| [Create Product](#create-product) | Creates a new product. |
| [Update Product](#update-product) | Updates an existing product. |
| [Find Deals Associated With Person](#find-deals-associated-with-person) | Finds multiple deals related to a specific person. |
| [Find Product](#find-product) | Finds a product by name |
| [Find Products](#find-products) | Finds a product or products by name or product code. |
| [Find Notes](#find-notes) | Finds notes by Deal, Lead, Person, or Organization ID. |
| [Retrieve a Product](#retrieve-a-product) | Finds a product by ID. |
| [Find Organization](#find-organization) | Finds an organization. |
| [Find Person](#find-person) | Finds a person. |
| [Find Deal](#find-deal) | Finds a deal by any field. |
| [Find Activity](#find-activity) | Finds an activity by subject. |
| [Find User](#find-user) | Finds a user by name or email. |
| [Find Lead](#find-lead) | Finds leads by title. |
| [Custom API Call](#custom-api-call) | Make a custom API call to a specific endpoint |

## Triggers

| Trigger | Fires when |
| - | - |
| [New Person](#new-person) | Triggers when a new person is created |
| [New Deal](#new-deal) | Triggers when a new deal is created. |
| [New Activity](#new-activity) | Triggers when a new activity is added |
| [New Note](#new-note) | Triggers when a new note is created. |
| [Updated Person](#updated-person) | Triggers when a person is updated. |
| [Updated Deal](#updated-deal) | Triggers when a deal is updated. |
| [Updated Deal Stage](#updated-deal-stage) | Triggers when a deal's stage is updated. |
| [New Lead](#new-lead) | Triggers when a new lead is created. |
| [New Organization](#new-organization) | Triggers when a new organization is created. |
| [Updated Organization](#updated-organization) | Triggers when an existing organization is updated. |
| [Activity Matching Filter](#activity-matching-filter) | Trigges when an activity newly matches a Pipedrive filter for the first time. |
| [Deal Matching Filter](#deal-matching-filter) | Trigges when a deal newly matches a Pipedrive filter for the first time. |
| [Person Matching Filter](#person-matching-filter) | Triggers when a person newly matches a Pipedrive filter for the first time. |
| [Organization Matching Filter](#organization-matching-filter) | Triggers when an organization newly matches a Pipedrive filter for the first time. |

## Prerequisites

* A Pipedrive account with access to the records and features your tools will use.
* Permission to authorize the Pipedrive OAuth access requested in the integration profile. The connector requests these scopes: `base`, `admin`, `contacts:full`, `users:read`, `deals:full`, `activities:full`, `leads:full`, `products:full`, `webhooks:full`.

## Set up the integration

**1. Connect Pipedrive**

In **Integrations**, select **Pipedrive** > **Connect**. Create an **Integration Profile** for Pipedrive, complete the OAuth 2.0 setup, and authorize the Pipedrive account your tools will use.

**2. Create an action tool**

In **Tools**, select **New Tool** > **Action** > **Pipedrive** > **Continue**. Select the action and auth profile, configure its inputs, and create the tool. Then [assign the tool to an agent](https://koreai.mintlify.site/agent-platform/tools/actions.md#assign-an-action-to-an-agent).

## Action reference

The tables include required and optional inputs shown in the Studio action builder. Dropdown values and record options depend on your Pipedrive account.

> [accordion] Add Follower
>
> | Parameter | Type | Required |
> | - | - | - |
> | `followerId` | number | Yes |
> | `entity` | dropdown | Yes |
> | `entityId` | string | Yes |

> [accordion] Retrieve a Note
>
> | Parameter | Type | Required |
> | - | - | - |
> | `noteId` | number | Yes |

> [accordion] Create Note
>
> | Parameter | Type | Required |
> | - | - | - |
> | `content` | string | Yes |
> | `dealId` | number | No |
> | `pinnedToDeal` | boolean | No |
> | `personId` | number | No |
> | `pinnedToPerson` | boolean | No |
> | `organizationId` | number | No |
> | `pinnedToOrganization` | boolean | No |
> | `leadId` | string | No |
> | `pinnedToLead` | boolean | No |

> [accordion] Add Labels to Person
>
> | Parameter | Type | Required |
> | - | - | - |
> | `personId` | number | Yes |
> | `labelIds` | array | Yes |

> [accordion] Add Product to Deal
>
> | Parameter | Type | Required |
> | - | - | - |
> | `dealId` | number | Yes |
> | `productId` | number | Yes |
> | `price` | number | Yes |
> | `quantity` | number | Yes |
> | `discount` | number | No |
> | `discountType` | dropdown | No |
> | `comments` | string | No |
> | `enableProduct` | boolean | No |
> | `taxMethod` | dropdown | No |
> | `taxPercentage` | number | No |

> [accordion] Attach File
>
> | Parameter | Type | Required |
> | - | - | - |
> | `file` | string | Yes |
> | `fileName` | string | Yes |
> | `dealId` | number | No |
> | `personId` | number | No |
> | `organizationId` | number | No |
> | `productId` | number | No |
> | `activityId` | number | No |

> [accordion] Create Activity
>
> | Parameter | Type | Required |
> | - | - | - |
> | `subject` | string | Yes |
> | `organizationId` | number | No |
> | `personId` | number | No |
> | `dealId` | number | No |
> | `leadId` | string | No |
> | `assignTo` | dropdown | No |
> | `type` | dropdown | No |
> | `dueDate` | string | No |
> | `dueTime` | string | No |
> | `duration` | string | No |
> | `isDone` | boolean | No |
> | `busy` | dropdown | No |
> | `note` | string | No |
> | `publicDescription` | string | No |

> [accordion] Update Activity
>
> | Parameter | Type | Required |
> | - | - | - |
> | `activityId` | number | Yes |
> | `subject` | string | No |
> | `organizationId` | number | No |
> | `personId` | number | No |
> | `dealId` | number | No |
> | `leadId` | string | No |
> | `assignTo` | dropdown | No |
> | `type` | dropdown | No |
> | `dueDate` | string | No |
> | `dueTime` | string | No |
> | `duration` | string | No |
> | `isDone` | boolean | No |
> | `busy` | dropdown | No |
> | `note` | string | No |
> | `publicDescription` | string | No |

> [accordion] Create Deal
>
> | Parameter | Type | Required |
> | - | - | - |
> | `title` | string | Yes |
> | `creationTime` | string | No |
> | `status` | dropdown | No |
> | `stageId` | dropdown | No |
> | `pipelineId` | dropdown | No |
> | `ownerId` | dropdown | No |
> | `organizationId` | number | No |
> | `personId` | number | No |
> | `labelIds` | array | No |
> | `probability` | number | No |
> | `expectedCloseDate` | string | No |
> | `dealValue` | number | No |
> | `dealValueCurrency` | string | No |
> | `visibleTo` | dropdown | No |
> | `customfields` | object | No |

> [accordion] Update Deal
>
> | Parameter | Type | Required |
> | - | - | - |
> | `dealId` | number | Yes |
> | `title` | string | No |
> | `creationTime` | string | No |
> | `status` | dropdown | No |
> | `stageId` | dropdown | No |
> | `pipelineId` | dropdown | No |
> | `ownerId` | dropdown | No |
> | `organizationId` | number | No |
> | `personId` | number | No |
> | `labelIds` | array | No |
> | `probability` | number | No |
> | `expectedCloseDate` | string | No |
> | `dealValue` | number | No |
> | `dealValueCurrency` | string | No |
> | `visibleTo` | dropdown | No |
> | `customfields` | object | No |

> [accordion] Create Lead
>
> | Parameter | Type | Required |
> | - | - | - |
> | `title` | string | Yes |
> | `ownerId` | dropdown | No |
> | `organizationId` | number | No |
> | `personId` | number | No |
> | `labelIds` | array | No |
> | `expectedCloseDate` | string | No |
> | `visibleTo` | dropdown | No |
> | `channel` | dropdown | No |
> | `leadValue` | number | No |
> | `leadValueCurrency` | string | No |
> | `customfields` | object | No |

> [accordion] Update Lead
>
> | Parameter | Type | Required |
> | - | - | - |
> | `leadId` | string | Yes |
> | `title` | string | No |
> | `ownerId` | dropdown | No |
> | `organizationId` | number | No |
> | `personId` | number | No |
> | `labelIds` | array | No |
> | `expectedCloseDate` | string | No |
> | `visibleTo` | dropdown | No |
> | `channel` | dropdown | No |
> | `leadValue` | number | No |
> | `leadValueCurrency` | string | No |
> | `customfields` | object | No |

> [accordion] Create Organization
>
> | Parameter | Type | Required |
> | - | - | - |
> | `name` | string | Yes |
> | `ownerId` | dropdown | No |
> | `visibleTo` | dropdown | No |
> | `labelIds` | array | No |
> | `address` | string | No |
> | `customfields` | object | No |

> [accordion] Update Organization
>
> | Parameter | Type | Required |
> | - | - | - |
> | `organizationId` | number | Yes |
> | `name` | string | No |
> | `ownerId` | dropdown | No |
> | `visibleTo` | dropdown | No |
> | `labelIds` | array | No |
> | `address` | string | No |
> | `customfields` | object | No |

> [accordion] Create Person
>
> | Parameter | Type | Required |
> | - | - | - |
> | `name` | string | No |
> | `ownerId` | dropdown | No |
> | `organizationId` | number | No |
> | `email` | array | No |
> | `phone` | array | No |
> | `labelIds` | array | No |
> | `firstName` | string | No |
> | `lastName` | string | No |
> | `visibleTo` | dropdown | No |
> | `marketing_status` | dropdown | No |
> | `customfields` | object | No |

> [accordion] Update Person
>
> | Parameter | Type | Required |
> | - | - | - |
> | `personId` | number | Yes |
> | `name` | string | No |
> | `ownerId` | dropdown | No |
> | `organizationId` | number | No |
> | `email` | array | No |
> | `phone` | array | No |
> | `labelIds` | array | No |
> | `firstName` | string | No |
> | `lastName` | string | No |
> | `visibleTo` | dropdown | No |
> | `marketing_status` | dropdown | No |
> | `customfields` | object | No |

> [accordion] Create Product
>
> | Parameter | Type | Required |
> | - | - | - |
> | `name` | string | Yes |
> | `code` | string | No |
> | `description` | string | No |
> | `unit` | string | No |
> | `tax` | number | No |
> | `isActive` | boolean | No |
> | `ownerId` | dropdown | No |
> | `currency` | string | No |
> | `price` | number | No |
> | `cost` | number | No |
> | `overheadCost` | number | No |
> | `visibleTo` | dropdown | No |
> | `customfields` | object | No |

> [accordion] Update Product
>
> | Parameter | Type | Required |
> | - | - | - |
> | `id` | string | Yes |
> | `name` | string | No |
> | `code` | string | No |
> | `description` | string | No |
> | `unit` | string | No |
> | `tax` | number | No |
> | `isActive` | boolean | No |
> | `ownerId` | dropdown | No |
> | `currency` | string | No |
> | `price` | number | No |
> | `cost` | number | No |
> | `overheadCost` | number | No |
> | `visibleTo` | dropdown | No |
> | `customfields` | object | No |

> [accordion] Find Deals Associated With Person
>
> | Parameter | Type | Required |
> | - | - | - |
> | `personId` | number | Yes |

> [accordion] Find Product
>
> | Parameter | Type | Required |
> | - | - | - |
> | `searchTerm` | string | Yes |

> [accordion] Find Products
>
> | Parameter | Type | Required |
> | - | - | - |
> | `field` | dropdown | Yes |
> | `fieldValue` | string | Yes |

> [accordion] Find Notes
>
> | Parameter | Type | Required |
> | - | - | - |
> | `objectType` | dropdown | Yes |
> | `objectId` | string | Yes |

> [accordion] Retrieve a Product
>
> | Parameter | Type | Required |
> | - | - | - |
> | `productId` | number | Yes |

> [accordion] Find Organization
>
> | Parameter | Type | Required |
> | - | - | - |
> | `searchField` | dropdown | Yes |
> | `searchFieldValue` | object | Yes |

> [accordion] Find Person
>
> | Parameter | Type | Required |
> | - | - | - |
> | `searchField` | dropdown | Yes |
> | `searchFieldValue` | object | Yes |

> [accordion] Find Deal
>
> | Parameter | Type | Required |
> | - | - | - |
> | `searchField` | dropdown | Yes |
> | `searchFieldValue` | object | Yes |

> [accordion] Find Activity
>
> | Parameter | Type | Required |
> | - | - | - |
> | `subject` | string | Yes |
> | `exactMatch` | boolean | No |
> | `assignTo` | dropdown | No |
> | `type` | dropdown | No |
> | `filterId` | dropdown | No |
> | `status` | dropdown | No |

> [accordion] Find User
>
> | Parameter | Type | Required |
> | - | - | - |
> | `field` | dropdown | Yes |
> | `fieldValue` | string | Yes |

> [accordion] Find Lead
>
> | Parameter | Type | Required |
> | - | - | - |
> | `term` | string | Yes |
> | `exact_match` | boolean | No |

> [accordion] Custom API Call
>
> | Parameter | Type | Required |
> | - | - | - |
> | `url` | object | Yes |
> | `method` | dropdown | Yes |
> | `headers` | object | Yes |
> | `queryParams` | object | Yes |
> | `body_type` | dropdown | No |
> | `body` | object | No |
> | `response_is_binary` | boolean | No |
> | `failsafe` | boolean | No |
> | `timeout` | number | No |
> | `followRedirects` | boolean | No |

## Trigger reference

> [accordion] New Person
>
> Triggers when a new person is created
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | — | — | — | No configurable inputs. |

> [accordion] New Deal
>
> Triggers when a new deal is created.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | — | — | — | No configurable inputs. |

> [accordion] New Activity
>
> Triggers when a new activity is added
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | — | — | — | No configurable inputs. |

> [accordion] New Note
>
> Triggers when a new note is created.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | — | — | — | No configurable inputs. |

> [accordion] Updated Person
>
> Triggers when a person is updated.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | — | — | — | No configurable inputs. |

> [accordion] Updated Deal
>
> Triggers when a deal is updated.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | `filter_by` | dropdown | No | Filter by: Deal Status, Stage in Pipeline |
> | `filter_by_field_value` | dynamic property selector | No | Field Values; choices depend on `filter_by` |
> | `field_to_watch` | dropdown | No | Field to watch for Changes On |

> [accordion] Updated Deal Stage
>
> Triggers when a deal's stage is updated.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | `stage_id` | dropdown | No | Stage in Pipeline |

> [accordion] New Lead
>
> Triggers when a new lead is created.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | — | — | — | No configurable inputs. |

> [accordion] New Organization
>
> Triggers when a new organization is created.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | — | — | — | No configurable inputs. |

> [accordion] Updated Organization
>
> Triggers when an existing organization is updated.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | — | — | — | No configurable inputs. |

> [accordion] Activity Matching Filter
>
> Trigges when an activity newly matches a Pipedrive filter for the first time.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | `filterId` | dropdown | Yes | Filter |

> [accordion] Deal Matching Filter
>
> Trigges when a deal newly matches a Pipedrive filter for the first time.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | `filterId` | dropdown | Yes | Filter |
> | `status` | dropdown | No | Status: Open, Won, Lost, Deleted, All(Not Deleted); default: `all_not_deleted` |

> [accordion] Person Matching Filter
>
> Triggers when a person newly matches a Pipedrive filter for the first time.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | `filterId` | dropdown | Yes | Filter |

> [accordion] Organization Matching Filter
>
> Triggers when an organization newly matches a Pipedrive filter for the first time.
>
> | Parameter | Type | Required | Details |
> | - | - | - | - |
> | `filterId` | dropdown | Yes | Filter |

## Troubleshoot common issues

| Issue | Resolution |
| - | - |
| OAuth authorization fails | Confirm the Pipedrive OAuth profile is configured and authorize the account that has access to the records used by your tools. |
| A record, owner, label, or pipeline option is missing | Check that it exists in the connected Pipedrive account and that the authorized user can access it. |
| A trigger doesn't fire | Check the selected filter, deal status, watched field, or pipeline stage settings. Matching-filter triggers fire when an item newly matches the selected filter. |
| An action fails to find or update a record | Verify the record ID and required fields for the selected Pipedrive object. |

## Related articles

* [Auth profiles](https://koreai.mintlify.site/agent-platform/administration/integrations-settings.md#auth-profiles)
* [Action Tools](https://koreai.mintlify.site/agent-platform/tools/actions.md)
* [Pipedrive API documentation](https://developers.pipedrive.com/docs/api/v1)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.