@orchesty/connector-active-campaign
v2.0.2
Published
Readme
ActiveCampaign Connector
An Orchesty connector for ActiveCampaign, a cloud-based customer experience automation (CXA) platform combining email marketing, marketing automation, sales automation, and CRM for small-to-mid-sized businesses.
Application Type
Basic
This connector authenticates using an API token sent as the api-token request header. No OAuth flow is required — credentials are entered directly in Orchesty.
| Field | Description |
|---|---|
| application_token | Your ActiveCampaign API key |
| subdomain | Your ActiveCampaign account name (the subdomain part of your account URL) |
Components
| Class | Type | Description |
|---|---|---|
| ActivateCampaignCreateAccountConnector | Connector | Creates a new account (organization) via POST /api/3/accounts |
| ActiveCampaignListAccountsBatch | Batch | Lists all accounts using offset-based pagination (GET /api/3/accounts, 50 records per page) |
Setup
Credentials
- Log in to your ActiveCampaign account.
- Navigate to Settings → Developer.
- Under API Access, copy your API URL — the subdomain is the part before
.api-us1.com(e.g. if your URL ishttps://mycompany.api-us1.com, the subdomain ismycompany). - Copy the API Key shown on the same page.
- In Orchesty, open the ActiveCampaign application settings and fill in:
- Application key — paste your API Key
- Account name — paste your subdomain
API Documentation
ActiveCampaign API Reference: https://developers.activecampaign.com/reference
Installation & Usage
Install the package:
npm install @orchesty/connector-active-campaign @orchesty/nodejs-sdk
# or
pnpm add @orchesty/connector-active-campaign @orchesty/nodejs-sdkRegister the application and nodes in your Orchesty DI container:
import { container } from '@orchesty/nodejs-sdk';
import ActiveCampaignApplication from '@orchesty/connector-active-campaign/dist/ActiveCampaignApplication';
import ActivateCampaignCreateAccountConnector from '@orchesty/connector-active-campaign/dist/Connector/ActivateCampaignCreateAccountConnector';
import ActiveCampaignListAccountsBatch from '@orchesty/connector-active-campaign/dist/Batch/ActiveCampaignListAccountsBatch';
const activeCampaignApp = new ActiveCampaignApplication();
container.setApplication(activeCampaignApp);
container.setNode(new ActivateCampaignCreateAccountConnector(), activeCampaignApp);
container.setNode(new ActiveCampaignListAccountsBatch(), activeCampaignApp);License
This connector is released under the Apache License 2.0. See the LICENSE file for the full license text.
Contributing
Contributions are welcome! This connector is part of the open-source Orchesty Node.js Connectors monorepo.
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the Contributing to Connectors guide.
All contributions should include:
- Source code in
src/following the existing connector structure - Tests in
src/**/__tests__/withinput.json,mock.json, andoutput.jsonfixtures - An updated
CHANGELOG.mdentry
