Automatisierungen und Ereignisse
Jeder Befehl für Automatisierungen, die Personen darin und die Ereignisse, die sie voranbringen, mit durchgerechneten Beispielen.
Wie alles zusammenhängt
Eine Automatisierung ist ein Auslöser und ein Baum aus Schritten. Sie hat einen Entwurf und eine Live-Version: update ändert den Entwurf und die Einstellungen, und publish friert den Entwurf ein und schaltet die Automatisierung ein. Lesen erfordert automations:read und Ändern erfordert automations:write. publish, resume und send-test erfordern außerdem emails:send, weil die Automatisierung dadurch Mail sendet.
openemail automations create --name "Welcome series" --starter welcome-seriesopenemail automations update aut_5c1e9a7b3d2f48e6a0b4c7d1 --data @welcome.jsonopenemail automations publish aut_5c1e9a7b3d2f48e6a0b4c7d1openemail automations stats aut_5c1e9a7b3d2f48e6a0b4c7d1Die Definition ist JSON, schreiben Sie sie also in eine Datei und übergeben Sie sie mit --data @file. openemail automations get <id> --json gibt die aktuelle aus, und deren problems listet auf, was der Veröffentlichung noch im Weg steht.
Automatisierungen
| Befehl | Was es tut |
|---|---|
| openemail automations list | Eine Seite der Automatisierungen, zuletzt geänderte zuerst. --status grenzt sie auf draft, live, paused oder archived ein |
| openemail automations create --name <value> | Einen Entwurf aus --starter, aus einer Definition in --data oder einen leeren erstellen |
| openemail automations get <id> | Eine Automatisierung mit ihrem Entwurf, ihrer Live-Version, ihren Einstellungen und dem, was am Entwurf nicht stimmt |
| openemail automations update <id> | Den Namen, die Einstellungen oder die Entwurfsdefinition ändern. --expected-updated-at verweigert das Überschreiben einer Änderung, die seit Ihrem Lesen gemacht wurde |
| openemail automations publish <id> | Den Entwurf als nächste Version einfrieren und die Automatisierung einschalten |
| openemail automations pause <id> | Eine aktive Automatisierung anhalten. Alle darin bleiben, wo sie sind |
| openemail automations resume <id> | Eine pausierte Automatisierung mit der Version wieder einschalten, die zuletzt lief |
| openemail automations archive <id> | Eine Automatisierung endgültig stilllegen und ihren Verlauf behalten. Alle darin verlassen sie |
| openemail automations duplicate <id> | Eine Automatisierung in einen neuen Entwurf kopieren, ohne ihre Personen und Zahlen |
| openemail automations delete <id> | Eine Automatisierung und ihren Verlauf nach Ihrer Bestätigung löschen. Eine Browser-Anmeldung verlangt außerdem einen Bestätigungscode |
| openemail automations list-starters | Die Ausgangspunkte, von denen eine neue Automatisierung ausgehen kann |
Testen, Versionen und Zahlen
| Befehl | Was es tut |
|---|---|
| openemail automations send-test <id> --step-key <value> | Einen E-Mail-Schritt des Entwurfs mit Beispielwerten an sich selbst oder an --to senden. Dabei wird niemand aufgenommen |
| openemail automations list-versions <id> | Jede veröffentlichte Version, neueste zuerst |
| openemail automations restore-version <id> <version> | Eine frühere Version zurück in den Entwurf kopieren. Veröffentlichen, damit sie läuft |
| openemail automations stats <id> | Summen, eine Zeile pro Schritt und ein Punkt pro Tag. --since legt fest, wo der Zeitraum beginnt, standardmäßig sind es die letzten 30 Tage |
Die Personen in einer Automatisierung
| Befehl | Was es tut |
|---|---|
| openemail automations list-enrollments <id> | Die eingetretenen Personen, neueste zuerst, mit dem Schritt, bei dem jede steht. --status und --step-key grenzen sie ein, und --all liest jede Seite |
| openemail automations get-enrollment <id> <enrollment-id> | Der Durchlauf einer Person, mit jedem ausgeführten Schritt und der E-Mail, die jeder Versand erzeugt hat |
| openemail automations enroll <id> --email <value> | Einen Kontakt beim ersten Schritt in eine aktive Automatisierung aufnehmen. --contact-id gibt den Kontakt stattdessen per ID an |
| openemail automations exit-enrollment <id> <enrollment-id> | Jemanden herausnehmen, bevor er fertig ist |
openemail automations list-enrollments aut_5c1e9a7b3d2f48e6a0b4c7d1 --status active --all --json | jq -r '.items[] | .contact.email + " " + (.stepKey // "")'Termine
Ein Ereignis besagt, dass ein Kontakt in Ihrem Produkt etwas getan hat. Es startet jede aktive Automatisierung, deren Auslöser es nennt, und lässt alle weitergehen, die darauf gewartet haben. Ein Ereignis zu senden erfordert contacts:write.
| Befehl | Was es tut |
|---|---|
| openemail events send --name <value> --email <value> | Ein Ereignis für einen Kontakt erfassen. --create-contact legt den Kontakt an, wenn noch niemand die Adresse hat, und --idempotency-key macht einen erneuten Versuch sicher |
| openemail events send-batch <events> | Bis zu 100 Ereignisse aus einer JSON-Datei erfassen und ausgeben, welche angenommen und welche abgelehnt wurden |
| openemail events list-names | Die Ereignisnamen, die der Workspace gesendet hat, zur Auswahl in einem Auslöser |
| openemail contacts list-events <email> | Die Ereignisse eines Kontakts, neueste zuerst. --name grenzt sie auf ein Ereignis ein |
openemail events send --data '{"name":"order.placed","email":"[email protected]","properties":{"orderId":"AC-4192"}}' --idempotency-key order:AC-4192:placedopenemail events send-batch @events.jsonopenemail contacts list-events [email protected] --name order.placedEigenschaften gehören in den JSON-Body, senden Sie ein Ereignis mit Eigenschaften also mit --data. Ereignisse werden 90 Tage aufbewahrt.