Skip to main content

ActiveCampaign Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

ActiveCampaign is a cloud-based marketing automation and customer relationship management (CRM) platform designed to help businesses engage with their customers through personalized email marketing, automation, and sales processes. It is widely used for email campaigns, lead nurturing, and customer segmentation.

The ActiveCampaign Reader connects to the ActiveCampaign platform and reads supported objects.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

✓

Custom objects

✓

Authentication

Basic authentication

✓

Username and password

OAuth authentication

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

✓

Initial load

✓

Pull-based incremental load

✓

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

✓

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

✓

Striim TQL

✓

Runtime

Resilience/recovery

✓

Parallel execution

Metrics

✓

Standard metrics

Supported authentication method

The ActiveCampaign Reader supports basic authentication using an API key as a basic authorization token. The key is associated with a user in your ActiveCampaign account (each user has their own unique API key) and allows access to the resources the user is authorized to use. You can find your API key in your ActiveCampaign account by selecting Settings > Developer > and locating the API section.

Supported objects

The following are the supported objects for reading from ActiveCampaign:

  • AccountContacts

  • AccountCustomFieldData

  • Accounts

  • Addresses

  • Automations

  • Campaigns

  • ContactAutomations

  • ContactCustomFieldData

  • ContactLists

  • ContactTags

  • Contacts

  • DealActivities

  • DealCustomFieldData

  • DealGroups

  • DealStages

  • Deals

  • Lists

  • Scores

  • Tags

  • Tasks

  • TrackingLogs

  • Users

ActiveCampaign Reader properties

Property

Type

Default value

Notes

URL

String

Base URL which is used to access the API.

API key

Password

The API key obtained from the ActiveCampaign portal. You can find your API key in your ActiveCampaign account by selecting Settings > Developer > and locating the API section.

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list:

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Refresh token

Password

An OAuth 2.0 refresh token.Use the value generated while creating the token.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.