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.
Hinweis: Verwenden Sie die neueste unterstützte API-Version für benutzerdefinierte Ereignisse. API v3 und API v5 sind veraltet. Beginnen Sie keine neuen Integrationen mit einer der beiden Versionen.
Wenn Ihre benutzerdefinierte Integration ihren eigenen API-Schlüssel verwendet, um API v3 oder v5 aufzurufen, kann Omnisend eine Warnung in Ihrem Konto anzeigen.Befolgen Sie die Migrationsanleitung, um Ihre Integration zu aktualisieren.API v5 wird am 30. Juni 2027 abgeschaltet.
Bevor Sie beginnen
Wenn Sie Ihren Webshop mit Omnisend integrieren, steht eine Reihe von Standardereignissen zur Verfügung, einschließlich Abonnieren von Marketing, Bestellung aufgegeben und Der Warenkorbabbruch. Wenn Sie einen Workflow für eine andere Art von Aktion auslösen möchten, müssen Sie ein benutzerdefiniertes Ereignis verwenden.
Benutzerdefinierte Ereignisse können sein:
Manuell über die API erstellt oder
Automatisch über die Integration mit einer drittanbieter App hinzugefügt.
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 geeignet, um sie korrekt mit den bereitgestellten technischen Details umzusetzen.
Benutzerdefinierte Ereignisse erscheinen nur im Dropdown-Menü der Automatisierungsauslöser 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: Info erhalten– Löst den Workflow aus, wenn eine Bestellung versendet wird.
Benutzerdefinierte Felder: Sendungsverfolgungsnummer, Sendungsverfolgungs-URL.
Intercom: Bewertung erstellt– Löst den Workflow aus, wenn ein Kontakt einen Kommentar für einen Supportmitarbeiter 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 erstelltLöst den Workflow aus, wenn eine Produktbewertung eingereicht wird.
Benutzerdefinierte Felder: Produktinformationen, Link zur Einreichung der Bewertung.
Erstellen Sie ein benutzerdefiniertes Ereignis.
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 sich ü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 die neueste Version als API-Referenz Version;
Navigieren Sie zu Ereignisse API → Ereignisse → Kundenereignis senden.
Schritt 3. Kopieren Sie den API-Schlüssel.
Gehen Sie zu Webshop-Einstellungen → API → API-Schlüssel erstellen und kopieren Sie Ihren 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. Vervollständigen Sie die Body-Parameter.
Befolgen Sie den Assistenten, um die erforderlichen Ereignisdetails einzugeben:
Kontakt Sie müssen mindestens einen Kontaktbezeichner angeben: eine E-Mail-Adresse oder Telefonnummer eines Kontakts, mit dem Sie das Ereignis übermitteln möchten.
Sie können auch zusätzliche Daten wie Adresse, Tags, Geburtsdatum oder benutzerdefinierte Eigenschaften einfügen. Diese werden im Kontaktprofil gespeichert und bleiben über die Zeit bestehen.
Ereignis-ID Zum Beispiel,
60ba330da4a60c8ed682c5bd:Ereignisname – Zum Beispiel,
Bewertung eingereicht;Ereigniszeit -Optional. Wenn verwendet, muss es ein vergangenes oder aktuelles Datum. 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 alle zusätzlichen Daten hinzu, um Ihren 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 Erstellung des Ereignisses:
Überprüfen Sie den 200-Statuscode in der API-Antwort, nachdem Sie auf "Versuchen" geklickt haben.
Gehen Sie zu Webshop-Einstellungen API Benutzerdefinierte Ereignisse, um zu bestätigen, dass das Ereignis in Ihrer 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 wird es in den Automatisierungs-Triggern angezeigt.
Wichtige Hinweise:
Um ein benutzerdefiniertes Ereignis zu bearbeiten, müssen Sie das vorhandene Ereignis löschen und ein neues mit der API-Dokumentation erstellen.
Deaktivieren eines benutzerdefinierten Ereignisses stoppt dessen Funktion, und alle Automatisierungen, die es als Auslöser 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 API-Schlüssels, der für das benutzerdefinierte Ereignis erstellt wurde, 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-Filtern, Split-Bedingungen und Nachrichtenpersonalisierungen 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, und geben Sie dann den nächsten Eigenschaftsnamen und seinen Wert ein.
Sobald Ihr benutzerdefiniertes Ereignis an Omnisend übergeben wurde, können Sie die synchronisierten Ereigniseigenschaften überprüfen, indem Sie zu Webshop-Einstellungen → API → Benutzerdefinierte Ereignisse gehen.
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, je nachdem, ob Sie sie in der API-Dokumentation oder in Omnisend anzeigen.
Wichtige Hinweise:
Eigenschaftsnamen sind interne Bezeichnungen, die verwendet werden, um die Daten in Automatisierungen und der Personalisierung von Nachrichten zu referenzieren.
Eigenschaftsnamen können nach der Erstellung des Ereignisses nicht geändert werden. Um einen Eigenschaftsnamen zu aktualisieren, löschen und erstellen Sie das Ereignis neu.
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 string.
🔌 Wir empfehlen, Ihren Entwickler oder Anbieter der Drittanbieter-Integration zu konsultieren, um das richtige Datenformat für jedes benutzerdefinierte Feld zu bestimmen.
Verwenden Sie benutzerdefinierte Ereignisse in der Automatisierung
Schritt 1: Erstellen Sie einen Workflow.
Gehen Sie zu Automatisierungen Workflow erstellen Von Grund auf neu erstellen.
Wählen Sie im Dropdown-Menü für den Auslöser Ihr benutzerdefiniertes Ereignis aus.
Schritt 2: Konfigurieren Sie die Workflow-Einstellungen.
Sobald Sie den Auslöser 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 (dies sind die Ereigniseigenschaften, die Sie über die API definiert haben).
Block aufteilen – Arbeitsabläufe basierend auf benutzerdefinierten Feldern.
Schritt 3: Nachrichtentext personalisieren
Sie können Daten aus benutzerdefinierten Feldern verwenden, um den Inhalt Ihrer Nachrichten zu personalisieren, einschließlich E-Mail, SMS und Push-Benachrichtigungen.
Wenn Sie einen Link als Ereigniseigenschaft übergeben, können Sie ihn auch mit einem Button in Ihrer E-Mail verwenden.
Verwenden Sie den Abmeldelink in der Automatisierung
Wenn Sie ein benutzerdefiniertes Ereignis verwenden, um einen Automatisierungsworkflow auszulösen, enthält der Fußzeileninhalt 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 Workflow-Kanaleinstellungen, indem Sie auf den Auslöserblock klicken und die Einstellungen anpassen.
Fehlerbehebung
Problem 1: Das benutzerdefinierte Ereignis erscheint nicht im Dropdown-Menü der Automatisierungsauslöser.
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.
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, gehen Sie zu Webshop-Einstellungen → API → API-Protokolle und überprüfen Sie 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 Standard-Omnisend-API, sodass benutzerdefinierte Felder möglicherweise nicht wie erwartet angezeigt werden.
Um dies zu beheben:
Verwenden Sie die
{{}}-Vorlagenvariablen-Syntax, wenn Sie Felder in Shopify Flow-Aktionen zuordnen.Stellen Sie sicher, dass die Feldnamen genau so übereinstimmen, wie sie in Webshop-Einstellungen API Benutzerdefinierte Ereignisse definiert sind (sie sind groß-/kleinschreibungsempfindlich).
Beachten Sie: Shopify Flow-Ereignisse erscheinen nicht in den API-Protokollen in Omnisend, da dies das erwartete Verhalten ist.
Für vollständige Anweisungen zur Einrichtung siehe den Artikel Shopify Flow mit Omnisend integrieren.
Problem 4: Das Ereignis hat funktioniert, aber jetzt wird es nicht mehr ausgelöst.
Wenn Ihr Ereignis plötzlich nicht mehr ausgelöst wird:
Gehen Sie 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 Auslöser verwenden.
Überprüfen Sie 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 Kontaktbenutzerdefinierten Eigenschaften und Ereigniseigenschaften?
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 Segmentierungen 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 Automatisierungsworkflows.
Kann ich die Namen von 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 vorhandene 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?
Verwenden Sie die neueste unterstützte API-Version, die in der aktuellen API-Dokumentation angezeigt wird.API v3 und API v5 sind veraltet.
Kann ich URLs in Ereigniseigenschaften übergeben?
Ja. URLs können als Zeichenfolgenwerte in Ereigniseigenschaften übergeben werden. Sie können in Automatisierungsfiltern, Aufteilungsbedingungen, Segmentierungsregeln oder direkt im Nachrichtentext unter Verwendung von Personalisierungsvariablen wie [[event.referralLink]] verwendet werden.
Für weitere Unterstützung bei benutzerdefinierten Ereignissen zögern Sie nicht, uns unter [email protected] oder über den In-App-Chat zu kontaktieren.