ActiveCampaign Konnektor

ActiveCampaign ist eine Cloud-Softwareplattform für die Automatisierung von E-Marketing-Kampagnen.
Der Konnektor ermöglicht den Austausch von Stammdaten zwischen ActiveCampaign und Syncler und unterstützt dabei auch benutzerdefinierte Felder für Accounts und Contacts.

Die Einrichtung erfolgt über die REST API von ActiveCampaign.
Dazu müssen die notwendigen Zugangsdaten über das Web-Portal bereitgestellt werden:

  • API URL
  • API Key

Diese Informationen finden Sie im ActiveCampaign-Portal unter:
SettingsDeveloper.

⚠️ Achten Sie darauf, dass der verwendete API Key über ausreichende Berechtigungen verfügt, da andernfalls keine vollständige Lese- oder Schreibfunktionalität gegeben ist.


Voraussetzungen

  • Ein gültiger API Key aus dem ActiveCampaign-Portal
  • Zugriff auf die korrekte API URL (Basis-Endpunkt für API v3)
  • Ausreichende Benutzerrechte für den API Key, um Lesen und Schreiben zu ermöglichen
  • Optional: Konfiguration von Transformationen für Accounts-Contacts-Beziehungen in Syncler

Einrichtung

  1. API-Informationen beschaffen

    • Navigieren Sie im ActiveCampaign-Portal zu SettingsDeveloper.
    • Kopieren Sie die dort aufgeführte API URL und den API Key.
  2. System in Syncler anlegen

    • Erstellen Sie ein neues System mit dem Konnektor ActiveCampaign.
    • Tragen Sie die API URL (API v3 wird automatisch ergänzt) sowie den API Key ein.
    • Speichern Sie die Einstellungen, damit das System getestet und registriert wird.

Objekte

  • Das Schema wird fest vorgegeben und automatisch um die benutzerdefinierten Felder für Accounts und Contacts erweitert.

Lesen von Daten

  • Das Lesen erfolgt über die REST API.

  • Abfragen können über Grenzwerte erfolgen, um Änderungen zu ermitteln.

  • Einschränkung bei Accounts:

    • Der Grenzwert kann nicht direkt übergeben werden, sondern wird nachträglich als Filter eingesetzt.
    • Bei sehr großen Datenmengen kann dadurch hoher Datenverkehr entstehen.
    • Empfehlung: Übertragungsintervall größer wählen.
  • Unterstützt wird das abhängige Lesen von Contacts zu einem Account, um Folge-Syncs zu realisieren.

  • Filtermöglichkeiten:

    • Angabe in Feldnotation mit id|:| → Einzelabfrage eines Datensatzes
    • Angabe in Feldnotation mit Related und RelatedId → Abfrage von Contacts zu einem Account
    • Standardmäßig wird der Abfragefilter als URL-Ergänzung verwendet (z. B. für Suchabfragen)

Beispiele für Abfragen von Contacts

Quelle: ActiveCampaign Developer Reference

  • email=info@mydomain.com
  • email_like=mydomain.com
  • search=MyLastName

Beispiel für Accounts

  • search=MyCompany

Schreiben von Daten

  • Schreiben erfolgt über die REST API.
  • Unterstützte Operationen:
    • Anlegen von Accounts und Contacts
    • Aktualisieren bestehender Datensätze
    • Löschen von Datensätzen

⚠️ Einschränkung:

  • Die doppelte Verwendung einer E-Mail-Adresse führt beim Speichern zu einer Fehlermeldung.

Besonderheiten

  • Für die Kombination mit CAS stehen Vorlagen für eine bidirektionale Synchronisation der Stammdaten zur Verfügung.
  • Für die Realisierung der Account-Contact-Beziehungen werden Transformationen genutzt, die vorhandene Datensatz-Abbildungen abfragen.
    • Diese Transformationen müssen manuell auf den jeweiligen Sync angewendet werden, um die Funktion zu aktivieren.
  • Performance-Hinweis: Bei großen Datenmengen sollte das Intervall der Übertragungen angepasst werden, um unnötigen Traffic zu vermeiden.