# ActiveCampaign Destination Config Reference

ActiveCampaign is an email marketing and CRM destination. RudderStack creates and updates contacts from identify calls, and records track, page, and screen activity against them.

In an ActiveCampaign destination spec:

Sample configuration

yaml 
version: rudder/v1
kind: destination
metadata:
  name: activecampaign-prod
spec:
  id: activecampaign-prod
  display_name: ActiveCampaign Production
  type: active_campaign
  definition_version: 1
  enabled: true
  config:
    api_url: https://acme.api-us1.com
    api_key: "{{ .ACTIVECAMPAIGN_API_KEY }}"
    event_key: "{{ .ACTIVECAMPAIGN_EVENT_KEY }}"
    actid: "{{ .ACTIVECAMPAIGN_ACTID }}"

    connection_mode:
      web: hybrid
      cloud: cloud
    consent_management:
      web:
        - provider: oneTrust
          consents:
            - marketing

The above example connects web sources in hybrid mode, so page calls run through ActiveCampaign’s site tracking script while other events go through its API — see Source types.

Config keys

config accepts only the keys listed below. The shared config key rules cover unknown keys, defaults, and immutability.

Connection

api_url

Required

Type: string

Description: Your ActiveCampaign API URL, from Settings > Developer in your ActiveCampaign account.

Notes:

  • Must be a URL with a dotted hostname. The http:// or https:// scheme is optional.
  • Any URL containing .ngrok.io is rejected.
  • A {{ path || fallback }} template is accepted in place of a literal.

api_key

RequiredSecret

Type: string

Description: Your ActiveCampaign API key, from the same Developer settings page as api_url.

Notes:

  • At most 100 characters, and must not contain line breaks.
  • A {{ path || fallback }} template is accepted in place of a literal.
Supply it as a {{ .VAR }} reference rather than a literal — see Secrets.

Event tracking

event_key

Secret

Type: string

Description: Event key unique to your ActiveCampaign account, from Settings > Tracking > Event Tracking. RudderStack uses it to record track events.

Notes:

  • At most 100 characters, and must not contain line breaks.
  • A {{ path || fallback }} template is accepted in place of a literal.

actid

Secret

Type: string

Description: Your ActiveCampaign account ID for event tracking, from Settings > Tracking > Event Tracking API.

Notes:

  • At most 100 characters, and must not contain line breaks.
  • A {{ path || fallback }} template is accepted in place of a literal.

Per-source keys

Both keys are objects keyed by the local source type — the tokens listed under Source types. A key naming a source type this destination doesn’t support fails validation.

connection_mode

Type: object

Description: Maps each source type you connect to the mode its events reach ActiveCampaign in, using the modes in Source types.

Notes:

  • An entry is required for each source type you connect — see Connect a source.
  • A mode the source type doesn’t support on this destination fails validation — for example device for android.
yaml 
connection_mode:
  web: hybrid
  android_kotlin: cloud

Source types

ActiveCampaign accepts events from these source types in the mentioned connection modes:

Source type Connection mode
android cloud
android_kotlin cloud
ios cloud
ios_swift cloud
web cloud, device, hybrid
unity cloud
cloud cloud
react_native cloud
flutter cloud
cordova cloud

Only web offers a choice. In hybrid mode, RudderStack sends identify, track, and screen events through ActiveCampaign’s API and page events through ActiveCampaign’s native web SDK, which is how you get site tracking. See Send events in hybrid mode and Hybrid mode.

The dashboard additionally offers ActiveCampaign to AMP, Shopify, and Reverse ETL sources. Rudder CLI doesn’t manage those connections, so amp, shopify, and warehouse are invalid here.

Connect a source

An event stream connection to this destination is checked against two rules at validate time.

The source’s type must be supported. A source’s type resolves to one of the tokens above before the check — a JavaScript source resolves to web, and webhook and server-side SDK sources resolve to cloud. An unsupported type reports:

destination 'activecampaign-prod' (type 'active_campaign') does not support source 'my-source':
source type 'amp' is not among supported source types: android, android_kotlin, ...

The destination config must carry a connection_mode entry for that source type. This lives on the destination spec, not on the connection spec. Without it:

destination 'activecampaign-prod' config has no 'connection_mode' entry for source type 'web'

ActiveCampaign needs no additional config keys to connect a source of any type, in any mode.

Secrets

api_key, event_key, and actid are the secret keys. Write each as a {{ .VAR }} reference and supply the value at apply time:

yaml 
config:
  api_key: "{{ .ACTIVECAMPAIGN_API_KEY }}"
  event_key: "{{ .ACTIVECAMPAIGN_EVENT_KEY }}"
  actid: "{{ .ACTIVECAMPAIGN_ACTID }}"
bash 
export RUDDER_ACTIVECAMPAIGN_API_KEY="..."
rudder-cli apply

# or
rudder-cli apply --var-file secrets.vars.yaml

Note that:

See How to Use Variable Substitution in Rudder CLI.

See more