Die n8n-Integration für Optimizely Campaign

  • Aktualisiert

Grundlagen

Über n8n

n8n ist eine Plattform zur Automatisierung von Aufgaben durch die Verknüpfung verschiedener Anwendungen und Dienste. Weitere Informationen finden Sie in der n8n-Benutzerdokumentation. Hier liegt der Schwerpunkt auf der Verknüpfung von Optimizely Campaign und n8n. Sie sollten daher ein Grundverständnis von n8n haben, bevor Sie weiterlesen.

Der Name n8n ist die Abkürzung für nodemation und wird n-eight-n ausgesprochen.

Das Paket n8n-nodes-optimizely-campaign

Die Fähigkeiten von n8n lassen sich durch das Hinzufügen von Knotentypen erweitern. Die Optimizely-Campaign-Knotentypen für n8n sind über npm im Paket @optimizely-campaign/n8n-nodes-optimizely-campaign verfügbar. Wenn Sie Ihre eigene n8n-Instanz hosten, müssen Sie diese selbst installieren; siehe dazu Voraussetzungen und Einrichtung weiter unten.

Die n8n-Canvas mit einem Workflow und einigen Optimizely-Campaign-Knoten

Voraussetzungen und Einrichtung

Benutzerkonten

Für die Nutzung der n8n-Integration für Optimizely Campaign müssen folgende Voraussetzungen erfüllt sein:

  • Wenn Sie sich in der DACH-Region befinden, benötigen Sie einen Optimizely-Campaign-API-Benutzer mit der Rolle bm – Webservice User Integration-Platform. Der Optimizely-Support hilft Ihnen bei der Erstellung eines API-Benutzers mit dieser Rolle.
  • Wenn Sie sich außerhalb der DACH-Region befinden, benötigen Sie einen Optimizely Campaign API-Benutzer mit der Rolle epi – Webservice User Integration-Platform. Sie können einen solchen Benutzer selbst anlegen; bei Problemen wenden Sie sich bitte an den Support.
  • Sie verfügen über die Anmeldedaten für diesen API-Benutzer.
  • Sie können sich mit einem anderen Benutzerkonto bei Optimizely Campaign anmelden (nicht zwingend erforderlich, aber für das Testen Ihrer Workflows dringend empfohlen).
  • Sie verfügen über ein Benutzerkonto auf einer n8n-Instanz.

n8n verwendet die Anmeldedaten des API-Benutzers für die Kommunikation mit Optimizely Campaign; siehe dazu den Abschnitt Campaign-API-Zugangsdaten konfigurieren weiter unten.

Mit vielen E-Mail-Postfachanbietern können Sie mithilfe von E-Mail-Subadressen ganz einfach einen neuen Benutzer anlegen. Wenn Ihre Adresse beispielsweise first.last@example.com lautet, können Sie den Benutzer Vorname.Nachname+n8n@example.com als neuen Benutzer in Optimizely Campaign anlegen. Obwohl es sich um unterschiedliche Campaign-Benutzer handelt, werden E-Mail-Nachrichten für beide Adressen in Ihrem Posteingang für first.last@example.com eingehen.

Die Knotentypen für Campaign installieren

Kontext: In selbstgehosteten Instanzen von n8n müssen Sie das Paket n8n-nodes-optimizely-campaign manuell hinzufügen.

Voraussetzungen: Sie sind bei n8n mit Administratorrechten angemeldet.

  1. Klicken Sie unten rechts auf (Einstellungen).
    → Ein pop-up-Menü erscheint.
  2. Klicken Sie auf Community Nodes.
    → Sie sehen die Seite Community Nodes.
  3. Klicken Sie auf Install.
    → Das Menü Install Community Nodes wird angezeigt.
  4. Geben Sie im Feld npm Package Name den Text „@optimizely-campaign/n8n-nodes-optimizely-campaign“ ein.
  5. Setzen Sie ein Häkchen, um zu bestätigen, dass Sie die Risiken des Hinzufügens von Paketen verstehen.
  6. Klicken Sie auf Installieren.
    → Die Optimizely Campaign-Knoten werden in Ihrer n8n-Instanz installiert.

Alternativ können Sie das npm-Paket auch über das Terminal auf Ihrem Server mit dem folgenden Befehl installieren:
npm install @optimizely-campaign/n8n-nodes-optimizely-campaign

Campaign-API-Zugangsdaten konfigurieren

Kontext: n8n nutzt ein Campaign-API-Benutzerkonto, um mit Campaign zu kommunizieren. Dazu müssen Sie die Anmeldedaten eines API-Benutzers in n8n eingeben.

Voraussetzungen: Sie kennen die Anmeldedaten eines Campaign-API-Benutzers mit der erforderlichen Rolle (siehe Benutzerkonten). Sie sind in n8n angemeldet.

  1. Klicken Sie oben links auf der n8n-Seite auf + (Plus).
  2. Wählen Sie im Popup-Menü Credential aus.
    → Das Menü Add new credential wird angezeigt.
  3. Geben Sie im Feld Select an app or service to connect to den Text „Optimizely Campaign“ ein.
  4. Wählen Sie aus der Dropdown-Liste Optimizely Campaign API aus.
  5. Klicken Sie auf Continue.
  6. Geben Sie den Benutzernamen (E-Mail-Adresse), das Passwort und die Mandanten-ID Ihres Campaign-Mandanten ein.
    Hinweis: Die Mandanten-ID finden Sie in Campaign unter Verwaltung > API-Übersicht.
    → Wenn Ihre Anmeldedaten korrekt sind, wird die Meldung Connection tested successfully angezeigt.
  7. Klicken Sie auf Save.

Die Knoten für Optimizely Campaign

Überblick

In einem n8n-Workflow steuern Knoten, was wann geschieht. Wenn Sie in n8n einen Knoten hinzufügen, suchen Sie nach „Optimizely Campaign“, um die Knoten aus Campaign anzuzeigen. Jeder Knoten gehört zu einer von zwei Kategorien:

  • Trigger, die Workflows steuern,
  • Aktionen, die in Workflows ausgeführt werden.

Folgende Trigger von Optimizely Campaign sind verfügbar:

  • On archive
  • On blocklist
  • On bounce
  • On click
  • On confirmedoptin
  • On doubleoptin
  • On filtered by blocklist
  • On open
  • On sent
  • On singleoptin
  • On spamcomplaint
  • On unsubscribe

Folgende Aktionen in Optimizely Campaign sind verfügbar:

  • Create a recipient
  • Update a recipient
  • Get a recipient
  • Send a transactional message

Zusätzlich zu den Campaign-spezifischen Knoten, gibt es eine weitere sehr mächtige Option:

  • Der allgemeine Knoten HTTP-Anfrage von n8n kann Anfragen an die Campaign REST API senden.

Um einen Prozess zu automatisieren, an dem Optimizely Campaign und eine andere Anwendung beteiligt sind, erstellen Sie einen n8n-Workflow, der einen Trigger oder eine Aktion aus Optimizely Campaign mit einem Trigger oder einer Aktion aus der anderen Anwendung kombiniert.

Datenübertragung durch Trigger

Technisch gesehen sind die Campaign-Trigger in n8n HTTP-Anfragen (Webhooks). Wenn ein relevantes Ereignis eintritt, sendet Campaign eine POST-Anfrage an n8n. Die Werte aus dem Anfrage-Body können dann im nächsten Knoten des Workflows verwendet werden.

Wenn Sie nach einem Trigger einen Aktionsknoten hinzufügen, werden die Datenfelder im Menü Input auf der linken Seite der Ansicht Node Details des Aktionsknotens angezeigt. Sie können diese Datenfelder in die Eingabefelder des Aktionsknotens ziehen. Bei jedem Durchlauf werden dann die vom Trigger bereitgestellten Werte in der Aktion verwendet.

Datenfelder eines Triggers anzeigen

Kontext: Jeder Trigger stellt einen bestimmten Satz von Datenfeldern bereit, die in nachfolgenden Knoten verwendet werden können.

Voraussetzungen: Sie sind bei n8n angemeldet.

  1. Öffnen oder erstellen Sie einen Workflow.
  2. Öffnen oder fügen Sie einen Campaign-Trigger hinzu.
  3. Klicken Sie auf der rechten Seite der Ansicht Node Details auf Test this trigger.
  4. Öffnen Sie die Registerkarte JSON.
    → Die Datenfelder sind im JSON-Code sichtbar.
    Hinweis: Der folgende Screenshot zeigt die standardmäßigen Beispiel-Daten für Click-Ereignisse, die mit einem grünen Rahmen hervorgehoben sind. Sie können sehen, welche Datenfelder in diesem Triggertyp verfügbar sind.
Die Ansicht Node Details eines Trigger-Knotens für Klicks in E-Mails aus Campaign. Variablen und Platzhalterwerte sind hervorgehoben.