Benutzerdefinierte Ereignisse lösen Automatisierungs-Workflows über die API aus und übergeben zusätzliche Daten für die Personalisierung. Jedes Ereignis kann benutzerdefinierte Felder enthalten, wie z. B. Tracking-Nummern, Produktdetails oder Bewertungslinks, die in Workflow-Inhalten verwendet werden.
Während Standardauslöser (wie Bestellung aufgegeben oder Der Warenkorbabbruch) gängige Ereignisse abdecken, ermöglichen benutzerdefinierte Ereignisse Ihnen, einzigartige Aktionen wie eingereichte Bewertungen oder erstellte Geschenkkarten zu automatisieren, die über die integrierten Auslöser von Omnisend hinausgehen.
Bevor Sie beginnen
Wenn Sie Ihren Webshop mit Omnisend integrieren, stehen eine Reihe von Standardereignissen zur Verfügung, einschließlich Abonnieren von Marketing, Bestellung aufgegeben und Der Warenkorbabbruch. Wenn Sie einen Workflow für einen anderen Aktionstyp auslösen möchten, müssen Sie ein Benutzerdefiniertes Ereignis verwenden.
Benutzerdefinierte Ereignisse können sein:
Manuell über die API erstellt, oder;
Automatisch hinzugefügt durch die Integration mit einer drittanbieter App.
Omnisend unterstützt und empfiehlt die Verwendung von nur API v5 für benutzerdefinierte Ereignisse. Frühere Versionen, wie v3, sind weiterhin funktionsfähig, werden jedoch nicht mehr aktiv unterstützt.
Wenn Sie zuvor nicht mit APIs gearbeitet haben, empfehlen wir dringend, einen Entwickler hinzuzuziehen, um bei der Einrichtung benutzerdefinierter Ereignisse zu helfen.
Die API-Dokumentation erklärt, wie die Integration funktioniert, aber ein Entwickler ist am besten ausgestattet, um sie korrekt mit den bereitgestellten technischen Details umzusetzen.
Benutzerdefinierte Ereignisse erscheinen nur im Dropdown-Menü für Automatisierungs-Trigger nachdem sie mindestens einmal ausgelöst wurden.
Benutzerdefinierte Ereignisse erfordern einen identifizierten Kontakt (E-Mail oder Telefonnummer), um zu funktionieren. Anonyme Besucher führen zu einem 400-Fehler.
💡 Beispiele für benutzerdefinierte Ereignisse, die von Drittanbieter-Tools hinzugefügt wurden
AfterShip: Informationen erhalten– Löst den Workflow aus, wenn eine Bestellung versendet wird.
Benutzerdefinierte Felder: Sendungsnummer, Sendungsverfolgungs-URL.
Intercom: Bewertung erstellt– Löst den Workflow aus, wenn ein Kontakt einen Kommentar für einen Support-Agenten hinterlässt.
Benutzerdefinierte Felder: Bewertung, Bewertungsinhalt.
Growave: Wunschliste Wieder verfügbar– Löst den Workflow aus, wenn ein Wunschlistenartikel wieder verfügbar ist.
Benutzerdefinierte Felder: Produktdetails.
Junip: Bewertung erstellt– Löst den Workflow aus, wenn eine Produktbewertung eingereicht wird.
Benutzerdefinierte Felder: Produktinformationen, Link zur Übermittlung von Bewertungen.
Ein benutzerdefiniertes Ereignis erstellen
Damit das benutzerdefinierte Ereignis funktioniert, müssen Sie es zu Ihrem Omnisend-Konto hinzufügen und auf der Seite des Drittanbieters einrichten.
Schritt 1. Zugriff auf benutzerdefinierte Ereignisse.
Navigiere zu Webshop-Einstellungen → API → Benutzerdefinierte Ereignisse → Klicke auf Benutzerdefiniertes Ereignis erstellen, um zu beginnen.
Schritt 2. Richten Sie es über die API-Dokumentation ein.
Sie werden zur API-Dokumentation weitergeleitet, wo Ihr Entwickler die Einrichtung abschließen und das benutzerdefinierte Ereignis erstellen kann. Hier müssen Sie:
Wählen Sie v5 als API-Referenz Version;
Navigieren Sie zu Events API → Events → Kundenereignis senden.
Schritt 3. Kopiere den API-Schlüssel.
Gehe zu Webshop-Einstellungen → API → API-Schlüssel erstellen und kopiere deinen API-Schlüssel.
Schritt 4. Fügen Sie den API-Schlüssel in den Header ein.
Wählen Sie in der API-Dokumentation Header aus und fügen Sie Ihren API-Schlüssel in das Header-Feld ein.
Schritt 5. Körperparameter vervollständigen.
Befolgen Sie den Assistenten, um die erforderlichen Ereignisdetails einzugeben:
Der Kontakt – Sie müssen mindestens einen Kontaktbezeichner angeben: eine E-Mail-Adresse oder Telefonnummer eines Kontakts, mit dem Sie das Ereignis übergeben möchten.
Sie können auch zusätzliche Daten wie Adresse, Tags, Geburtsdatum oder benutzerdefinierte Eigenschaften einfügen. Diese werden im Kontaktprofil gespeichert und bestehen über die Zeit.
Ereignis-ID – Zum Beispiel,
60ba330da4a60c8ed682c5bd:Ereignisname – Zum Beispiel,
Überprüfung eingereicht;Ereigniszeit -Optional. Wenn verwendet, muss es ein vergangenes oder gegenwärtiges Datum sein. Zukünftige Daten führen dazu, dass das Ereignis fehlschlägt.
Ereignisversion - Optional. Kann für benutzerdefinierte Ereignisse leer gelassen werden.
Ursprung - Dies sollte immer auf
"api"Eigenschaften (optional) – Fügen Sie zusätzliche Daten hinzu, um Ihren Der Workflow zu personalisieren (siehe Beispielstruktur unten).
Sobald Sie fertig sind, klicken Sie auf Versuchen, um das Ereignis zu erstellen.
Schritt 6. Testen Sie Ihr Ereignis.
Überprüfen Sie die Ereigniserstellung:
Überprüfen Sie den 200-Statuscode in der API-Antwort, nachdem Sie auf "Try it" geklickt haben.
Gehe zu Webshop-Einstellungen → API → Benutzerdefinierte Ereignisse, um zu bestätigen, dass das Ereignis in deiner Liste erscheint.
Wenn du auf Fehler stößt, überprüfe Webshop-Einstellungen → API → API-Protokolle für Details.
🔁 Ein Testereignis auslösen:
Verwenden Sie den POST /events Endpunkt, um das Ereignis manuell auszulösen. Dadurch erscheint es in den Automatisierungs-Triggern.
Wichtige Hinweise:
Um ein benutzerdefiniertes Ereignis zu bearbeiten, müssen Sie das vorhandene Ereignis löschen und ein neues über die API-Dokumentation erstellen.
Deaktivieren eines benutzerdefinierten Ereignisses stoppt dessen Funktion, und alle Automatisierungen, die es als Der Trigger verwenden, werden eingestellt.
Ein benutzerdefiniertes Ereignis wieder aktivieren bedeutet nicht automatisch den zugehörigen Workflow reaktivieren. Sie müssen die Automatisierung manuell wieder aktivieren.
Das Löschen des für das benutzerdefinierte Ereignis erstellten API-Schlüssels führt dazu, dass Ihr Ereignis fehlschlägt.
Ereigniseigenschaften hinzufügen
Eigenschaften(auch als benutzerdefinierte Felder in Omnisend bezeichnet)zusätzliche Daten mit jedem Ereignis übergeben (z. B. Produktname, Tracking-URL, Bewertungsbewertung). Diese Daten können in Workflow-Filter, Split-Bedingungen und die Personalisierung von Nachrichten verwendet werden.
Um Ereigniseigenschaften hinzuzufügen, gehen Sie zu Eigenschaften → Eigenschaften-Objekt. Geben Sie den Eigenschaftsnamen und seinen Wert ein. Um zusätzliche Eigenschaften einzuschließen, klicken Sie auf Feld hinzufügen, geben Sie dann den nächsten Eigenschaftsnamen und dessen Wert ein.
Sobald dein benutzerdefiniertes Ereignis an Omnisend übergeben wurde, kannst du die synchronisierten Ereigniseigenschaften überprüfen, indem du zu Webshop-Einstellungen → API → Benutzerdefinierte Ereignisse gehst.
Klicken Sie auf den Ereignisnamen, um die zugehörigen benutzerdefinierten Felder anzuzeigen.
Hinweis: Sobald das benutzerdefinierte Ereignis mit Omnisend synchronisiert wird, erscheinen die Ereigniseigenschaften in der Benutzeroberfläche als benutzerdefinierte Felder. Diese Begriffe beziehen sich auf dieselben Daten; der einzige Unterschied ist das verwendete Label, abhängig davon, ob Sie sie in der API-Dokumentation oder innerhalb von Omnisend anzeigen.
Wichtige Hinweise:
Eigenschaftsnamen sind interne Bezeichnungen, die verwendet werden, um auf die Daten in Automatisierungen und der Personalisierung von Nachrichten zu verweisen.
Eigenschaftsnamen können nicht geändert werden, nachdem das Ereignis erstellt wurde. Um einen Eigenschaftsnamen zu aktualisieren, löschen und erstellen Sie das Ereignis erneut.
Eigenschaftswerte können sich im Laufe der Zeit ändern, indem neue Ereignisse mit aktualisierten Werten gesendet werden.
Beispiel: Wenn ein Kontakt eine 1-Stern-Bewertung hinterlässt, senden Sie ein Ereignis mit
reviewType: "1 Stern". Wenn sie es später auf 2 Sterne aktualisieren, senden Sie ein neues Ereignis mitreviewType: "2 Sterne".
Sie können mehrere Werte nicht in einer einzelnen Eigenschaft übergeben (z. B.
"1 Stern, 2 Sterne"). Senden Sie ein Ereignis pro Wertänderung.Der einzige unterstützte Werttyp für Eigenschaftsfelder ist Zeichenfolge.
⚡ Wir empfehlen, Ihren Entwickler oder den Anbieter der Drittanbieterintegration zu konsultieren, um das richtige Datenformat für jedes Benutzerdefiniertes Feld zu bestimmen.
Verwenden Sie benutzerdefinierte Ereignisse in der Automatisierung
Schritt 1: Erstellen Sie einen Der Workflow.
Gehen Sie zu Automatisierungen → Der Workflow erstellen → Von Grund auf neu erstellen.
Im Dropdown-Menü für den Trigger finden Sie Ihr benutzerdefiniertes Ereignis.
Schritt 2: Konfigurieren Sie die Der Workflow-Einstellungen.
Sobald Sie den Trigger für das Benutzerdefinierte Ereignis hinzufügen, werden alle Workflow-Einstellungen mit Daten aus dem Ereignis ausgefüllt:
Der Trigger-Filter – Nach Werten des Benutzerdefinierten Feldes filtern (das sind die Ereigniseigenschaften, die Sie über die API definiert haben).
Split-Block – Arbeitsabläufe basierend auf benutzerdefinierten Feldern verzweigen.
Schritt 3: Nachrichtinhalt personalisieren
Sie können Daten aus benutzerdefinierten Feldern verwenden, um den Inhalt Ihrer Nachrichten zu personalisieren, einschließlich E-Mail, Die SMS und Push-Benachrichtigungen.
Wenn Sie einen Link als Ereigniseigenschaft übergeben, können Sie ihn auch mit einem Button in Ihrer Die E-Mail verwenden.
Verwenden Sie den Abmeldelink in der Automatisierung
Wenn Sie ein benutzerdefiniertes Ereignis verwenden, um einen Automatisierungs-Workflow auszulösen, enthält der Fußzeileninhalt block standardmäßig einen Abmeldelink.
Wir empfehlen, diesen Link in allen Nachrichten einzufügen. Es ist jedoch nicht erforderlich, wenn die Nachricht transaktional ist (z. B. im Zusammenhang mit einer Bestellung, die der Kunde aufgegeben hat).
Wichtig: Automatisierungs-Workflows, die durch benutzerdefinierte Ereignisse ausgelöst werden sendet standardmäßig Nachrichten an abgemeldete Kontakte. Wenn Sie nicht an abgemeldete Kontakte senden möchten, aktualisieren Sie die Einstellungen für den Workflow-Kanal, indem Sie auf den Trigger-Block klicken und die Präferenzen anpassen.
Fehlerbehebung
Problem 1: Benutzerdefiniertes Ereignis erscheint nicht im Dropdown-Menü für Automatisierungs-Trigger.
Dies ist zu erwarten, da Ereignisse in der Liste der Automatisierungsauslöser nur erscheinen, nachdem sie mindestens einmal ausgelöst wurden.
Verwenden Sie den POST /events-Endpunkt, um das Ereignis manuell auszulösen. Dies lässt es in Automatisierungsauslösern erscheinen.
Beispiel API-Aufruf (v5):
POST https://api.omnisend.com/v5/events
Headers:
X-API-KEY: your-api-key
Content-Type: application/json
Body:
{
"origin": "api",
"email": "[email protected]",
"eventName": "Product Back in Stock",
"fields": {
"productName": "Blue Widget",
"productURL": "https://yourstore.com/products/blue-widget"
}
}
Problem 2: Erhalt eines 400-Fehlers beim Auslösen des Ereignisses.
Ein 400-Fehler weist auf ein payload-bezogenes Problem hin, was bedeutet, dass die an Omnisend gesendete Anfrage ungültig ist. Diese Fehler stammen von der Senderseite, nicht von Omnisend.
Um dies zu beheben, gehe zu Webshop-Einstellungen → API → API-Protokolle und überprüfe die 400-Fehler.
💡 Sie können den Dropdown-Filter verwenden, um nur 400-Level-Fehler anzuzeigen.
Problem 3: Shopify Flow benutzerdefinierte Felder erscheinen nicht.
Shopify Flow verwendet einen anderen Endpunkt und eine andere JSON-Struktur als die standardmäßige Omnisend API, sodass benutzerdefinierte Felder möglicherweise nicht wie erwartet angezeigt werden.
Um dies zu lösen:
Verwenden Sie die
##{{}}Template-Variablen-Syntax, wenn Sie Felder in Shopify Flow-Aktionen zuordnen.Stelle sicher, dass die Feldnamen genau so übereinstimmen, wie sie in Webshop-Einstellungen → API → Benutzerdefinierte Ereignisse definiert sind (sie sind groß-/kleinschreibungsempfindlich).
Beachte: Shopify Flow-Ereignisse erscheinen nicht in den API-Protokollen in Omnisend, da dies das erwartete Verhalten ist.
Für vollständige Einrichtungsanweisungen siehe den Artikel Shopify Flow mit Omnisend integrieren.
Problem 4: Ereignis funktionierte, jetzt wird es nicht mehr ausgelöst.
Wenn Ihr Ereignis plötzlich aufhört, ausgelöst zu werden:
Gehe zu Webshop-Einstellungen → API → Benutzerdefinierte Ereignisse, um zu überprüfen, ob das Ereignis noch aktiviert ist.
Wenn das Ereignis gelöscht wurde, müssen Sie es neu erstellen und alle Workflows aktualisieren, die es als Der Trigger verwenden.
Überprüfe die API-Protokolle unter Webshop-Einstellungen → API → API-Protokolle auf kürzliche Fehler oder fehlgeschlagene Anfragen.
Häufig gestellte Fragen
Warum nennt die API-Dokumentation sie "Ereigniseigenschaften", während Omnisend sie "benutzerdefinierte Felder" nennt?
Dies ist ein terminologischer Unterschied zwischen der API-Dokumentation und der Omnisend-Oberfläche. Wenn Sie Ereigniseigenschaften in der API-Dokumentation erstellen, werden sie mit Omnisend synchronisiert und als benutzerdefinierte Felder in Automatisierungs-Workflows, Triggern, Splits und Nachrichtenpersonalisierung angezeigt. Beide Begriffe beziehen sich auf dieselben Daten: die zusätzlichen Informationen, die mit jedem benutzerdefinierten Ereignis übermittelt werden.
Was ist der Unterschied zwischen den benutzerdefinierten Eigenschaften des Kontakts und den Ereigniseigenschaften?
Der Kontakt benutzerdefinierte Eigenschaftenwerden im Kontaktprofil gespeichert und bestehen über die Zeit. Sie werden über das
customProperties-Objekt innerhalb derKontakt-Objektblock der Ereignislast. Diese Werte sind im Kontaktprofil sichtbar und können in Kampagnen, Automatisierungen und Die Segmentierung wiederverwendet werden.Ereigniseigenschaften hingegen werden im
Eigenschaftenblock des Ereignisses übergeben. Sie sind nur an das ausgelöste Ereignis gebunden, als benutzerdefinierte Felder gekennzeichnet und bestehen nicht im Kontaktprofil. Diese sind nützlich für ereignisspezifische Bedingungen, wie das Filtern nach Produktname, Bewertungsnote oder Bestellsumme innerhalb von Automatisierungs-Workflows.
Kann ich die Namen der Ereigniseigenschaften nach der Erstellung eines Ereignisses bearbeiten?
Nein. Die Eigenschaftsnamen können nicht geändert werden, sobald das Ereignis erstellt wurde. Wenn Sie eine Eigenschaft umbenennen müssen, müssen Sie das bestehende Ereignis löschen und ein neues mit dem aktualisierten Eigenschaftsnamen erstellen.
Hinweis: Das Löschen eines aktiven Ereignisses deaktiviert alle Workflows, die es als Der Trigger verwenden.
Welche API-Version sollte ich für benutzerdefinierte Ereignisse verwenden – v3 oder v5?
Verwenden Sie v5: https://api.omnisend.com/v5/events und fügen Sie "origin": "api" in Ihren Anfragekörper ein.
Während Ereignisse, die in der Benutzeroberfläche erstellt wurden, mit sowohl v3 als auch v5 kompatibel sind, ist v5 der aktuelle Standard und wird für alle neuen Implementierungen empfohlen.
Kann ich URLs in Ereigniseigenschaften übergeben?
Ja. URLs können als Zeichenfolgenwerte in Ereigniseigenschaften übergeben werden. Sie können in Die Automatisierung Filtern, Split-Bedingungen, Die Segmentierung Regeln oder direkt im Nachrichteninhalt unter Verwendung von Die Personalisierung Variablen wie [[event.referralLink]] verwendet werden.
Für weitere Unterstützung bei benutzerdefinierten Ereignissen zögern Sie nicht, uns unter [email protected] oder im In-App-Chat zu kontaktieren.