Beschreibung
Quelle | PerformX Adressen |
Ziel | |
Schnittstelle | Brevo API |
Dokumentation Brevo |
Konzept
Rollenaufteilung
Standardintegration von PerformX mit dem Newsletter-Tool Brevo via API von Brevo
Diese Schnittstelle wird mit dem PerformX-Connector realisiert und bietet die Möglichkeit, PerformX-Adressen für den Versand von Newslettern und Mailings direkt aus PerformX nach Brevo zu übertragen und zu aktualisieren
Das Führen und Administrieren der Segmentierung sowie auch die An-/Abmelde-Funktionen werden vollständig durch Brevo bereitgestellt. Es erfolgt keine Rückschreibung in PerformX
Brevo wird durch den Kunden, bzw. einen Drittpartner aufgesetzt, konfiguriert und betreut
Funktionsweise
Die gemäss Selektion definierten Adressen werden periodisch an Brevo übermittelt
Die von Brevo vergebene BrevoID wird im PerformX als Fremdschlüssel gespeichert, damit jederzeit eine Zuordnung möglich ist
Adressmutation übermittelter Adressen werden ebenfalls in Brevo aktualisiert
Löschungen und Inaktivierungen??
Versandlisten in Brevo
Aus PerformX werden zwei Versandlisten bedient:
Opt-In: Kontakte in dieser Liste müssen einen Opt-In-Prozess durchlaufen, bevor sie einen Newsletter erhalten
Newsletter: Kontakte in dieser Liste können direkt mit Newslettern beliefert werden, da sie den Opt-In-Prozess bereits auf einem anderen Weg durchlaufen haben
Initialimport
Für den erstmaligen Import der ausgewählten Adressen werden diese aus PerformX ex- und in die jeweils korrekte Liste in Brevo importiert. Der Connector synchronisiert anschliessend ausschliesslich die BrevoIDs der Adressen, welche in PerofrmX eine vordefinierte BrevoID eingetragen haben. Die Zuordnung erfolgt in diesem Fall über die in Brevo importierte E-Mail-Adresse und verschiedene E-Mail-Felder in PerformX.
Nach Abschluss des Initialimports werden die Zuordnungsdefinitionen auf Normalbetrieb eingestellt. Der Connector synchronisiert BrevoIDs nur, wenn das entsprechende Feld leer ist.
Bedingungen
Standard-Bedingung für Erstellung neuer Kontakte in Brevo |
(Aktiv == true) && (EMailNewsletter !? null && EMailNewsletter != '' ) && Relation.Count("Vertrag", "Datum \>= CreateDate(2022,1,1) && RolleID == 1") > 0 && EndOfDay(DatumMutation) > CurrentJob.LastSuccessfulExecution() && (BrevoID == null) |
Standard-Bedingung für Update in Brevo |
(Aktiv == true) && (BrevoID != null) && (EndOfDay(DatumMutation) > CurrentJob.LastSuccessfulExecution()) |
Vergabe Identifikation/Nummer | Brevo |
Parameter Aufgabe | -- |
Konfiguration Connector
Zuordnungsdefinition | |
Name | KUNDE: Brevo Contact-Sync |
Beschreibung/Notiz | |
Zuordnung 1 | |
Name | Kein Opt-In |
Sortierung | 1 |
Quellobjekt | Adresse |
Formel für Primärschlüsselfeld | -- |
Zielobjekt | /contacts:createContact |
Mapping Mandanten | Ein Mandant/eine Nummer pro Datensatz |
Synchronisations-Option | Update oder Insert |
Daten nach Operation zurücklesen | Ja |
Verwendeter Index | -- |
Felder (siehe Tabelle “Übertrag von PerformX nach Brevo) | Alle |
Brevo-Listen-ID “listid” | Gemäss Brevo Backend |
Zuordnung 2 | |
Name | Mit Opt-In |
Sortierung | 2 |
Quellobjekt | Adresse |
Formel für Primärschlüsselfeld | -- |
Zielobjekt | /contacts:createContact |
Mapping Mandanten | Ein Mandant/eine Nummer pro Datensatz |
Synchronisations-Option | Update oder Insert |
Daten nach Operation zurücklesen | Ja |
Verwendeter Index | -- |
Felder (siehe Tabelle “Übertrag von PerformX nach Brevo) | Alle |
Brevo-Listen-ID “listid” | Gemäss Brevo Backend |
Zuordnung 3 | |
Name | Brevo-ID Synch |
Sortierung | 3 |
Quellobjekt | Adresse |
Formel für Primärschlüsselfeld | -- |
Zielobjekt | /contacts/{email}:getContactInfo |
Mapping Mandanten | Ein Mandant/eine Nummer pro Datensatz |
Synchronisations-Option | Update oder Insert |
Daten nach Operation zurücklesen | Ja |
Verwendeter Index | -- |
Felder (siehe Tabelle “Übertrag von PerformX nach Brevo) | Alle |
Zuordnung 3 | |
Name | Update Contact |
Sortierung | 4 |
Quellobjekt | Adresse |
Formel für Primärschlüsselfeld | -- |
Zielobjekt | /contacts:createContact |
Mapping Mandanten | Ein Mandant/eine Nummer pro Datensatz |
Synchronisations-Option | Update oder Insert |
Daten nach Operation zurücklesen | Ja |
Verwendeter Index | -- |
Felder (siehe Tabelle “Übertrag von PerformX nach Brevo) | Alle |
Brevo-Listen-ID “listid” | Gemäss Brevo Backend |
Übertrag von PerformX nach Brevo
Brevo Beschreibung | PerformX Beschreibung | Mapping/Übertrag an Brevo | Beschreibung |
attributes[0].name | Formel “LASTUPDATE” | Selektiert Attribut “LASTUPDATE” in Brevo | |
attributes[0].numeric | DatumMutation | 1:1 | Überträgt ID nach attributes[0] |
attributes[1].name | Formel “LASTNAME” | Selektiert Attribut “LASTNAME” in Brevo | |
attributes[1].text | Name | 1:1 | Überträgt Name nach attributes[1] |
attributes[2].name | Formel “FIRSTNAME” | Selektiert Attribut “FIRSTNAME” in Brevo | |
attributes[2].text | Vorname | 1:1 | Überträgt Vorname nach attributes[2] |
attributes[3].name | Formel “SALUTATION | Selektiert Attribut “SALUTATION” in Brevo | |
attributes[3].text | Anrede.Anrede | 1:1 | Überträgt Vorname nach attributes[2] |
berechnet aus verschiedenen Feldern (siehe nächste Spalte) | Formel “EMailNewsletter ?? EMailD ?? EMail ?? EMailG” | Überträgt berechnete E-Mail nach email | |
listids | -- | Formel ‘Listen-ID’ (siehe Zuordnungen oben) | Listen-ID der Listen in Brevo |
attributes[4].name | Formel “LANGUAGE” | Selektiert Attribut “LANGUAGE” in Brevo | |
attributes[4].text | Sprache | 1:1 | Überträgt Sprache nach attributes[4] |
attributes[5].name | Formel “DATEOFBIRTH” | Selektiert Attribut “DATEOFBIRTH” in Brevo | |
attributes[5].text | Geburtsdatum | 1:1 | Überträgt Geburtsdatum nach attributes[5] |
attributes[6].name | Formel “SMS” | Selektiert Attribut “SMS” in Brevo | |
attributes[6].text | Natel | 1:1 | Überträgt Natel nach attributes[6] |
Übertrag von Brevo nach PerformX (Brevo-ID Sync)
Brevo Beschreibung | PerformX Beschreibung | Mapping/Übertrag an PerformX | Beschreibung |
ID | BrevoID | -- |
Übertrag von PerformX nach Brevo (Brevo-ID Sync)
Brevo Beschreibung | PerformX Beschreibung | Mapping/Übertrag an PerformX | Beschreibung |
-- | berechnet aus verschiedenen Feldern (siehe nächste Spalte) | Formel “EMailNewsletter ?? EMailD ?? EMail ?? EMailG” | Überträgt berechnete E-Mail für Synchronisation der BrevoID |
Definition Zielverbindung
Name | Brevo |
Verbindungsart | OpenAPI |
Serveradresse | https://api.brevo.com/v3 |
Relativer Pfad zur OpenAPI Definition | /swagger_definition.yml |
Client Secret | Siehe Keeper |
Verbindungszertifikat überprüfen | Ja |
Definition Quellverbindung
Standardverbindung PerformX-Connector
Aufgaben
Name | KUNDE: Brevo-Sync |
Zuordnungsdefinition | Gemäss Tabelle oben |
Quellverbindung | Gemäss Tabelle oben |
Zielverbindung | Gemäss Tabelle oben |
Ausführungsplanung | Gemäss Spezifikation |
Log Einstellung | Immer |
Ausführungsmodus | Vollständige Ausführung |
Max. Anzahl Datensätze | -- |
Konfiguration Brevo
Listen
Liste 1 | |
Name | KUNDE_OptIn |
Liste 2 | |
Name | identified_contacts |
Liste 2 | |
Name | KUNDE_Newsletter |
Kontaktattribute
Attributname | Attributart |
Text | |
SALUTATION | Text |
LASTNAME | Text |
FIRSTNAME | Text |
LANGUAGE | Text |
DATEOFBIRTH | Datum |
LASTUPDATE | Datum |
DOUBLE_OPT-IN | Kategorie |
SALUTATION | Text |