# Active Campaign CRM

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

<figure><img src="/files/jwOa0unfgIIYvpTAUk8K" alt=""><figcaption></figcaption></figure>

### Overview

#### Connector Details

| Connector Category                                                                      | API Connector |
| --------------------------------------------------------------------------------------- | ------------- |
| OvalEdge Releases Supported                                                             | Release8.1    |
| <p>Connectivity</p><p>\[How the connection is established with Active Campaign CRM]</p> | 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 Active Campaign CRM and mapped to the corresponding UI assets.

<table><thead><tr><th width="208.2000732421875">Active Campaign CRM Object</th><th width="214.800048828125">Active Campaign CRM Attribute</th><th width="176">OvalEdge Attribute</th><th width="181.60009765625">OvalEdge Category</th><th width="154.39990234375">OvalEdge Type</th></tr></thead><tbody><tr><td>Account Container</td><td>API Base URL</td><td>Container identifier</td><td>Container</td><td>Container</td></tr><tr><td>Contacts</td><td>Contact ID</td><td>Entity identifier</td><td>Table / Entity </td><td>Entity </td></tr><tr><td>Lists </td><td>List ID </td><td>Entity identifier</td><td>Table / Entity</td><td>Entity</td></tr><tr><td>Tags</td><td>Tag ID</td><td>Entity identifier</td><td>Table / Entity</td><td>Entity</td></tr><tr><td>Accounts </td><td>Account ID</td><td>Entity identifier</td><td>Table / Entity</td><td>Entity</td></tr><tr><td>Deals</td><td>Deal ID</td><td>Entity identifier</td><td>Table / Entity</td><td>Entity</td></tr><tr><td>Campaigns</td><td>Campaign ID</td><td>Report identifier</td><td>Report</td><td>Report</td></tr><tr><td>Fields</td><td>Field Schema</td><td>Column details </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 Access**

Ensure outbound port 443 (HTTPS) is allowed for OvalEdge to connect to the Active Campaign CRM API endpoints.

{% hint style="warning" %}
The connector uses HTTPS (port 443). If a proxy is used, ensure it allows HTTPS traffic and that communication between OvalEdge and Active Campaign CRM is not blocked or modified.
{% 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 Active Campaign CRM administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operation       | Objects          | System Tables           | Access Permission |
| --------------- | ---------------- | ----------------------- | ----------------- |
| Validation      | Contacts         | /api/3/contacts?limit=1 | Read              |
| Crawling        | Contacts         | /api/3/contacts         | Read              |
| Crawling        | Lists            | /api/3/lists            | Read              |
| Crawling        | Tags             | /api/3/tags             | Read              |
| Crawling        | Accounts         | /api/3/accounts         | Read              |
| Crawling        | Deals            | /api/3/deals            | Read              |
| Crawling        | Campaigns        | /api/3/campaigns        | Read              |
| Query / Preview | Selected Objects | Relevant endpoints      | Read              |

#### Connection Configuration Steps

{% hint style="warning" %}
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 **ActiveCampaign CRM**, and complete the required parameters.

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

<table><thead><tr><th width="220.4000244140625">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Active Campaign CRM</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 ActiveCampaign CRM connection              </p><p>(<strong>Example</strong>: "ActiveCampaign_CRM").</p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Base URL*</td><td><p>Enter  ActiveCampaign API base URL </p><p>(<strong>Example</strong>:  https://YOURACCOUNT.api-us1.com).</p></td></tr><tr><td>API Token*</td><td>Enter  ActiveCampaign API token from the ActiveCampaign UI. Used as Api-Token header.</td></tr><tr><td>Page Size</td><td>Enter maximun records per API call. (Maximum recommended 100)</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="220.763671875"></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 operation, 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.
  * **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.

<table><thead><tr><th width="93">S.No.</th><th width="227.50897216796875">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Invalid request.</td><td><p><strong>Error Description:</strong> </p><ul><li>Request payload is incomplete.</li></ul><p><strong>Resolution:</strong></p><ul><li>Select a valid container/object.</li><li>Retry the action.</li></ul></td></tr><tr><td>2</td><td>Missing entity type or id.</td><td><p><strong>Error Description:</strong> </p><ul><li>Entity type or ID is missing.</li></ul><p><strong>Resolution:</strong></p><ul><li>Select a supported entity (Contacts, Lists, Tags, Accounts, Deals).</li><li>Or select Campaigns report.</li><li>Retry the operation.</li></ul></td></tr><tr><td>3</td><td>Unsupported entity id</td><td><p><strong>Error Description:</strong> </p><ul><li>Entity is not supported.</li></ul><p><strong>Resolution:</strong></p><ul><li>Use supported entities only.</li><li>Verify object type.</li><li>Retry query/preview.</li></ul></td></tr><tr><td>4</td><td>Unsupported report id</td><td><p><strong>Error Description:</strong> </p><ul><li>Report ID is not supported.</li></ul><p><strong>Resolution:</strong></p><ul><li>Use Campaigns report only.</li><li>Verify report selection.</li><li>Retry.</li></ul></td></tr><tr><td>5</td><td>Unsupported entity type</td><td><p><strong>Error Description:</strong> </p><ul><li>Unsupported object category used.</li></ul><p><strong>Resolution:</strong></p><ul><li>Use Entities or Reports section.</li><li>Select valid object type.</li><li>Retry operation.</li></ul></td></tr><tr><td>6</td><td>Failed to validate ActiveCampaign connection</td><td><p><strong>Error Description:</strong> </p><ul><li>Connection validation failed.</li></ul><p><strong>Resolution:</strong></p><ul><li>Verify Base URL is correct and reachable.</li><li>Check API token validity and permissions.</li><li>Retry validation.</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/active-campaign-crm.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.