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:

• type: active_campaign
• definition_version: 1

Sample configuration

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

Event tracking

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:
  web: hybrid
  android_kotlin: cloud

Source types

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

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.

warehouse is the token a Reverse ETL source resolves to. Rudder CLI manages the destination’s warehouse entry — if the destination is connected to a Reverse ETL source, set connection_mode.warehouse: cloud in its spec, or apply removes it.

Rudder CLI can also declare the Reverse ETL connection itself, for the types listed under Supported destinations — see Manage Reverse ETL Connections using Rudder CLI.

The dashboard additionally offers ActiveCampaign to AMP and Shopify sources. Rudder CLI doesn’t manage those connections, so amp and shopify 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. Every type an event stream source can resolve to is supported here, so this check always passes.

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:

config:
  api_key: "{{ .ACTIVECAMPAIGN_API_KEY }}"
  event_key: "{{ .ACTIVECAMPAIGN_EVENT_KEY }}"
  actid: "{{ .ACTIVECAMPAIGN_ACTID }}"

export RUDDER_ACTIVECAMPAIGN_API_KEY="..."
export RUDDER_ACTIVECAMPAIGN_EVENT_KEY="..."
export RUDDER_ACTIVECAMPAIGN_ACTID="..."
rudder-cli apply

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

Note that:

• rudder-cli import writes only the secrets the API returns, as {{ .VAR }} references, and leaves the others out. Add any secret key it leaves out, then supply the variables before you apply — see Secrets.
• api_url isn’t a secret and is imported as-is.

See How to Use Variable Substitution in Rudder CLI.

Changes by release

For changes across every destination type, see Destination Type Changes by Release.

See more

• ActiveCampaign Destination for event mappings, tags, custom fields, and list subscriptions
• Destination Type Reference for Rudder CLI for the rules shared across destination types
• Destination YAML Reference for the spec envelope