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.
Overview
Connector Details
Connector Category
API Connector
OvalEdge Release supported
Release8.1
Connectivity
[How the connection is established with Pipedrive CRM]
REST APIs over HTTPS
The Pipedrive connector uses API-based validation by retrieving account/user details. If validation fails, verify the API token and company domain.
Connector Features
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.
Account container
Company identifier (name/domain/ID)
Container identifier
Container
Container
Deals
Deal identifier
Entity identifier
Table / entity
Entity
Persons
Person identifier
Entity identifier
Table / entity
Entity
Organizations
Organization identifier
Entity identifier
Table / entity
Entity
Products
Product identifier
Entity identifier
Table / entity
Entity
Activities
Activity identifier
Entity identifier
Table / entity
Entity
Leads
Lead identifier
Entity identifier
Table / entity
Entity
Pipelines
Pipeline identifier
Entity identifier
Table / entity
Entity
Stages
Stage identifier
Entity identifier
Table / entity
Entity
Users
User identifier
Entity identifier
Table / entity
Entity
Entity Fields
Field Schema (including custom fields)
Column name and type
Column
Column
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.
If a proxy is configured, ensure it allows HTTPS traffic to https://{your-company-domain}.pipedrive.com and that communication is properly established.
Service Account User Permissions
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.
👨💻 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.
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
Users are required to have the Connector Creator role in order to configure a new connection.
Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Pipedrive, and complete the required parameters.
Fields marked with an asterisk (*) are mandatory for establishing a connection.
Connector Type
By default, "Pipedrive" is displayed as the selected connector type.
Credential Manager*
Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.
Supported Credential Managers:
OE Credential Manager
AWS Secrets Manager
HashiCorp Vault
Azure Key Vault
Connector Name*
Enter a unique name for the Pipedrive CRM connection
(Example: "Pipedrive").
Connector description
Enter a brief description of the connector.
Company domain*
Enter Pipedrive company subdomain
(Example: mycompany for mycompany.pipedrive.com)
API Token*
Enter Personal API token from Pipedrive
(Company settings → Personal preferences → API)
Default Governance Roles
Default Governance Roles*
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.
Admin Roles
Admin Roles*
Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.
No of Archive Objects
No Of Archive Objects*
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.
Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.
Bridge
Select Bridge*
If applicable, select the bridge from the drop-down list.
The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.
After entering all connection details, the following actions can be performed:
Click Validate to verify the connection.
Click Save to store the connection for future use.
Click Save & Configure to apply additional settings before saving.
The saved connection will appear on the Connectors home page.
Manage Connector Operations
Crawl/Profile
To perform crawl operations, users must be assigned the Integration Admin role.
The Crawl/Profile button allows users to select one or more schemas for crawling.
Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to crawl.
The Crawl option is selected by default.
Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
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.
Click the Schedule checkbox to enable the Select Period drop-down.
Select a time period for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
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.
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.
1
Invalid connection config.
Error Description:
Required connection configuration was missing during validation.
Resolution:
Open the connector settings.
Provide all mandatory fields (Company domain and API token).
Click Validate again.
2
Company domain is required.
Error Description:
The Pipedrive company domain was not provided.
Resolution:
Edit the connector configuration.
Enter a valid Company domain (subdomain).
Retry validation.
3
API token is required.
Error Description:
The API token was missing during validation.
Resolution:
Generate or copy a valid API token from Pipedrive.
Enter the API token in the connector.
Validate the connection again.
4
Connection validation failed.
Error Description:
The API did not return expected account/user details during validation.
Resolution:
Verify the API token is valid and active.
Ensure the token has required permissions to access account data.
Retry validation.
5
Entity id is required.
Error Description:
Query or data preview was executed without selecting an entity record.
Resolution:
Navigate to the Data Catalog.
Select a valid entity (e.g., Deals, Persons).
Run query or preview again.
6
Entity type is required.
Error Description:
The request did not include the required entity type.
Resolution:
Open the selected connector object.
Choose a valid entity type.
Retry the operation.
7
Unknown entity type.
Error Description:
An unsupported entity type was selected.
Resolution:
Review the selected entity type.
Choose a supported entity (Deals, Persons, Organizations, Products, Activities, Leads, Pipelines, Stages, Users).
Re-run the request.
Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA
Last updated
Was this helpful?