Capsule CRM

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

Overview

Connector Details

Connector Category	API Connector
OvalEdge Releases Supported	Release8.1
Connectivity [How the connection is established with Capsule CRM]	REST APIs

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 Capsule CRM and mapped to the corresponding UI assets.

Capusle CRM Object	Capsule CRM Attribute	OvalEdge Attribute	OvalEdge Category	OvalEdge Type
Account Container	Capsule Account Identifier	Container Identifier	Container	Container
Parties	Party Record Identifier and Display Name	Entity Identifier	Table / Entity	Entity
Opportunities	Opportunity Record Identifier and Display Name	Entity Identifier	Table / Entity	Entity
Projects	Project Record Identifier and Display Name	Entity Identifier	Table / Entity	Entity
Users	User Record Identifier and Display Name	Entity Identifier	Table / Entity	Entity
Milestones	Milestone Record Identifier and Display Name	Entity Identified	Table / Entity	Entity
Pipelines	Pipeline Record Identifier and Display Name	Entity Identifier	Table / Entity	Entity
Record Attributes and Custom Fields	Field Schema	Column Name and Type	Column	Column

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Network and API access

The connector calls Capsule CRM over HTTPS. Ensure the OvalEdge environment can reach your Capsule CRM API base URL and that any corporate proxy allows HTTPS access to Capsule API endpoints.

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 Capsule CRM administrator, as users may not have the required access to assign them independently.

Operation	Objects	System Tables	Access Permission
Connection Validation	Current User	GET/ Users/Current	Token authorized to read current user details
Crawling / Discovery - Parties	Parties	GET /parties	Read access to parties
Crawling / Discovery - Opportunities	Oppotunites	GET /opportunity	Read access to opportunities
Crawling / Discovery - Projects	Projects (kases)	GET /kases	Read access to projects/cases
Crawling / Discovery - Users	Users	GET /users	Read access to users
Crawling / Discovery - Milestones	Milestones	GET /milestones	Read access to milestones
Crawling / Discovery - Pipelines	Pipelines	GET /pipelines	Read access to pipelines
Field Discovery - Record Fields	Field Definitions	GET /fields/definitions for the selected record type	Read access to field metadata
Query Sheet / Data Preview	Entity Records	GET /{records}/{id}, endpoints	Read access to the selected entity data

Connection Configuration Steps

Users are required to have the Connector Creator role in order to configure a new connection.

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

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name	Description
Connector Type	By default, "Capsule CRM" 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 Capsule CRM connection (Example: "Capsule_CRM").
API base URL	Enter the Capsule API URL (Example: https://api.capsulecrm.com/api/v2). The default value is pre-configured.
Connector description	Enter a brief description of the connector.
API Token*	Enter the personal API token from Capsule (My Preferences → API Authentication Tokens)

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.

1. 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.

2. 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. For Capsule CRM, the connector provides a single container that represents the Capsule CRM account.

The Crawl/Profile button allows users to select one or more schemas for crawling.

1. Navigate to the Connectors page and click Crawl/Profile.

2. Select the schemas to crawl.

3. The Crawl option is selected by default.

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.

  • Query Policies: Define query execution rules based on roles.

  • 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.

S.No.	Error Message(s)	Error Description & Resolution
1	Connection config is required.	Error Description: Connection details are missing during validation. Resolution: Enter all required fields (API Base URL and API Token) and validate again.
2	API token is required.	Error Description: API token is missing. Resolution: Enter a valid API token and retry.
3	Invalid or expired API token (401 Unauthorized)	Error Description: The API token is invalid, expired, or not authorized. Resolution: Generate a new token or reauthorize the existing one, then validate again.
4	Insufficient scope (403 Forbidden)	Error Description: The API token does not have the required permissions. Resolution: Update token permissions to allow read access to required objects and retry.
5	Invalid response from Capsule API	Error Description: The API response is not as expected during validation. Resolution: Verify the API Base URL and ensure the token is valid.
6	Connection failed	Error Description: API call failed during validation. Resolution: Check network connectivity, proxy settings, and token validity, then retry.
7	Connection config required	Error Description: Query or data preview was executed without a valid connection. Resolution: Ensure the connection is properly configured and selected, then retry.
8	Entity id required	Error Description: Record identifier is missing for query or preview. Resolution: Select a valid entity record and retry.
9	Unknown entity type	Error Description: Unsupported entity type was used. Resolution: Use supported entities such as Parties, Opportunities, Projects, Users, Milestones, and Pipelines.
10	API error	Error Description: Capsule CRM returned an error while fetching data. Resolution: Verify token permissions, object selection, and data availability, then retry.

---

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA