# Pipedrive

This article outlines the integration with the Pipedrive connector, enabling streamlined  metadata management through features such as crawling, and data preview. It also ensures secure authentication via Credential Manager.

<figure><img src="/files/8l0Zb6OS1usNx8Rrsm8k" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                                | API Connector        |
| --------------------------------------------------------------------------------- | -------------------- |
| OvalEdge Release supported                                                        | Release8.1           |
| <p>Connectivity</p><p>\[How the connection is established with Pipedrive CRM]</p> | REST APIs over HTTPS |

{% hint style="info" %}
The Pipedrive connector uses API-based validation by retrieving account/user details. If validation fails, verify the API token and company domain.
{% endhint %}

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ❌      |
| Query Sheet                                  |       ❌      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ❌      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ❌      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

### Metadata Mapping

The following objects are crawled from **Pipedrive** and mapped to the corresponding UI assets.

<table><thead><tr><th width="190.5999755859375">Pipedrive Object</th><th width="208.60003662109375">Pipedrive Attribute</th><th width="171.199951171875">OvalEdge Attribute</th><th width="173.5999755859375">OvalEdge Category</th><th width="146.39990234375">OvalEdge Type</th></tr></thead><tbody><tr><td>Account container</td><td>Company identifier (name/domain/ID)</td><td>Container identifier</td><td>Container</td><td>Container</td></tr><tr><td>Deals</td><td>Deal identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Persons</td><td>Person identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Organizations</td><td>Organization identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Products</td><td>Product identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Activities</td><td>Activity identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Leads</td><td>Lead identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Pipelines</td><td>Pipeline identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Stages</td><td>Stage identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Users</td><td>User identifier</td><td>Entity identifier</td><td>Table / entity</td><td>Entity</td></tr><tr><td>Entity Fields</td><td>Field Schema (including custom fields) </td><td>Column name and type</td><td>Column</td><td>Column</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

**Network and API Access**

Ensure outbound HTTPS connectivity (port 443) is enabled from the OvalEdge environment to the Pipedrive API endpoints.

{% hint style="warning" %}
If a proxy is configured, ensure it allows HTTPS traffic to https\://{your-company-domain}.pipedrive.com and that communication is properly established.
{% endhint %}

**Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
👨‍💻 Who can provide these permissions? These permissions are typically granted by the Pipedrive administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operation             | Objects         | System Tables              | Access Permission                              |
| --------------------- | --------------- | -------------------------- | ---------------------------------------------- |
| Connection validation | Account details | /api/v2/deals              | Valid API token with access to account details |
| Crawling / Query      | Deals           | /api/v2/persons            | Read access                                    |
| Crawling / Query      | Persons         | information\_schema.tables | Read access                                    |
| Crawling / Query      | Organizations   | /api/v2/organizations      | Read access                                    |
| Crawling / Query      | Products        | /api/v2/products           | Read access                                    |
| Crawling / Query      | Activities      | /api/v1/activities         | Read access                                    |
| Crawling / Query      | Leads           | /api/v1/leads              | Read access                                    |
| Crawling / Query      | Pipelines       | /api/v2/pipelines          | Read access                                    |
| Crawling / Query      | Stages          | /api/v2/stages             | Read access                                    |
| Crawling / Query      | Users           | /api/v1/users              | Read access                                    |
| Field Discovery       | Custom Fields   | Field APIs                 | Read access                                    |

### Connection Configuration Steps

{% hint style="info" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to **Administration > Connectors**, click **+ (New Connector),** search for **Pipedrive**, and complete the required parameters.

{% hint style="warning" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="218.79998779296875">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Pipedrive</strong>" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Pipedrive CRM connection              </p><p>(<strong>Example:</strong> "Pipedrive").</p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Company domain*</td><td><p>Enter  Pipedrive company subdomain </p><p>(<strong>Example:</strong> mycompany for mycompany.pipedrive.com)</p></td></tr><tr><td>API Token*</td><td><p>Enter  Personal API token from Pipedrive </p><p>(Company settings → Personal preferences → API)</p></td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="239.59991455078125"></th><th></th></tr></thead><tbody><tr><td><strong>Default Governance Roles</strong></td><td></td></tr><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.</td></tr><tr><td><strong>Admin Roles</strong></td><td></td></tr><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr><tr><td><strong>No of Archive Objects</strong></td><td></td></tr><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr><tr><td><strong>Bridge</strong></td><td></td></tr><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

### Manage Connector Operations

#### Crawl/Profile

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for crawling.&#x20;

1. Navigate to the **Connectors** page and click **Crawl/Profile**.
2. Select the **schemas** to **crawl**.
3. The **Crawl** option is selected by default.&#x20;
4. Click **Run** to collect metadata from the connected source and load it into the OvalEdge **Data Catalog**.
5. After a successful **crawl**, the information appears in the **Data Catalog > APIs/API Attributes tab**.

The **Schedule** checkbox allows automated **crawling** at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the Select **Period drop-down**.
2. Select a **time period** for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the **crawl** operation at the scheduled time.

#### Other Operations

The **Connectors** page in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connectors Health:** Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing:** Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

* **Edit Connector:** Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings:** Modify connector settings.
  * **Crawler:** Configure data extraction.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.&#x20;
* **Delete Connector:** Remove a connector with confirmation.

### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="87.4000244140625">S.No.</th><th width="262.800048828125">Error Message(s)</th><th width="376.39996337890625">Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Invalid connection config.</td><td><p><strong>Error Description:</strong> </p><ul><li>Required connection configuration was missing during validation.</li></ul><p><strong>Resolution:</strong></p><ul><li>Open the connector settings.</li><li>Provide all mandatory fields (Company domain and API token).</li><li>Click Validate again.</li></ul></td></tr><tr><td>2</td><td>Company domain is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>The Pipedrive company domain was not provided.</li></ul><p><strong>Resolution:</strong></p><ul><li>Edit the connector configuration.</li><li>Enter a valid Company domain (subdomain).</li><li>Retry validation.</li></ul></td></tr><tr><td>3</td><td>API token is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>The API token was missing during validation.</li></ul><p><strong>Resolution:</strong></p><ul><li>Generate or copy a valid API token from Pipedrive.</li><li>Enter the API token in the connector.</li><li>Validate the connection again.</li></ul></td></tr><tr><td>4</td><td>Connection validation failed.</td><td><p><strong>Error Description:</strong> </p><ul><li>The API did not return expected account/user details during validation.</li></ul><p><strong>Resolution:</strong></p><ul><li>Verify the API token is valid and active.</li><li>Ensure the token has required permissions to access account data.</li><li>Retry validation.</li></ul></td></tr><tr><td>5</td><td>Entity id is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>Query or data preview was executed without selecting an entity record.</li></ul><p><strong>Resolution:</strong></p><ul><li>Navigate to the Data Catalog.</li><li>Select a valid entity (e.g., Deals, Persons).</li><li>Run query or preview again.</li></ul></td></tr><tr><td>6</td><td>Entity type is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>The request did not include the required entity type.</li></ul><p><strong>Resolution:</strong></p><ul><li>Open the selected connector object.</li><li>Choose a valid entity type.</li><li>Retry the operation.</li></ul></td></tr><tr><td>7</td><td>Unknown entity type.</td><td><p><strong>Error Description:</strong> </p><ul><li>An unsupported entity type was selected.</li></ul><p><strong>Resolution:</strong></p><ul><li>Review the selected entity type.</li><li>Choose a supported entity (Deals, Persons, Organizations, Products, Activities, Leads, Pipelines, Stages, Users).</li><li>Re-run the request.</li></ul></td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/application/pipedrive.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.