Automatisations et événements
Chaque commande pour les automatisations, les personnes en cours et les événements qui les font avancer, avec des exemples détaillés.
Comment tout s'articule
Une automatisation, c'est un déclencheur et un arbre d'étapes. Elle garde un brouillon et une version en ligne : update modifie le brouillon et les paramètres, et publish fige le brouillon et active l'automatisation. La lecture nécessite automations:read et la modification automations:write. publish, resume et send-test nécessitent aussi emails:send, parce qu'ils font envoyer du courrier par l'automatisation.
openemail automations create --name "Welcome series" --starter welcome-seriesopenemail automations update aut_5c1e9a7b3d2f48e6a0b4c7d1 --data @welcome.jsonopenemail automations publish aut_5c1e9a7b3d2f48e6a0b4c7d1openemail automations stats aut_5c1e9a7b3d2f48e6a0b4c7d1La définition est du JSON, écrivez-la donc dans un fichier et passez-la avec --data @file. openemail automations get <id> --json affiche la définition actuelle, et son problems liste ce qui empêche encore sa publication.
Automatisations
| Commande | Ce qu'il fait |
|---|---|
| openemail automations list | Une page des automatisations, les plus récemment modifiées en premier. --status limite la liste à draft, live, paused ou archived |
| openemail automations create --name <value> | Créer un brouillon à partir de --starter, d'une définition dans --data, ou un brouillon vide |
| openemail automations get <id> | Une automatisation avec son brouillon, sa version en ligne, ses paramètres et ce qui ne va pas dans le brouillon |
| openemail automations update <id> | Modifier le nom, les paramètres ou la définition du brouillon. --expected-updated-at refuse d'écraser une modification faite depuis votre lecture |
| openemail automations publish <id> | Figer le brouillon comme prochaine version et activer l'automatisation |
| openemail automations pause <id> | Arrêter une automatisation en ligne. Toutes les personnes en cours restent où elles sont |
| openemail automations resume <id> | Réactiver une automatisation en pause avec la version qu'elle exécutait |
| openemail automations archive <id> | Retirer définitivement une automatisation en gardant son historique. Toutes les personnes en cours en sortent |
| openemail automations duplicate <id> | Copier une automatisation dans un nouveau brouillon, sans ses personnes ni ses chiffres |
| openemail automations delete <id> | Supprimer une automatisation et son historique après votre confirmation. Une connexion par navigateur demande aussi un code de vérification |
| openemail automations list-starters | Les points de départ dont une nouvelle automatisation peut partir |
Tests, versions et chiffres
| Commande | Ce qu'il fait |
|---|---|
| openemail automations send-test <id> --step-key <value> | Envoyer une étape e-mail du brouillon à vous-même, ou à --to, avec des valeurs d'exemple. Cela n'inscrit personne |
| openemail automations list-versions <id> | Toutes les versions publiées, de la plus récente à la plus ancienne |
| openemail automations restore-version <id> <version> | Recopier une version antérieure dans le brouillon. Publiez pour qu'elle s'exécute |
| openemail automations stats <id> | Des totaux, une ligne par étape et un point par jour. --since fixe le début de la période, par défaut les 30 derniers jours |
Les personnes en cours dans une automatisation
| Commande | Ce qu'il fait |
|---|---|
| openemail automations list-enrollments <id> | Les personnes entrées, les plus récentes en premier, avec l'étape où se trouve chacune. --status et --step-key limitent la liste, et --all lit toutes les pages |
| openemail automations get-enrollment <id> <enrollment-id> | Le parcours d'une personne, avec chaque étape exécutée et l'e-mail produit par chaque envoi |
| openemail automations enroll <id> --email <value> | Faire entrer un contact dans une automatisation en ligne à sa première étape. --contact-id désigne plutôt le contact par son id |
| openemail automations exit-enrollment <id> <enrollment-id> | Retirer quelqu'un avant la fin |
openemail automations list-enrollments aut_5c1e9a7b3d2f48e6a0b4c7d1 --status active --all --json | jq -r '.items[] | .contact.email + " " + (.stepKey // "")'Événements
Un événement indique qu'un contact a fait quelque chose dans votre produit. Il démarre chaque automatisation en ligne dont le déclencheur le nomme et fait avancer toute personne qui l'attendait. En envoyer un nécessite contacts:write.
| Commande | Ce qu'il fait |
|---|---|
| openemail events send --name <value> --email <value> | Enregistrer un événement pour un contact. --create-contact ajoute le contact quand personne n'a encore cette adresse, et --idempotency-key rend une nouvelle tentative sûre |
| openemail events send-batch <events> | Enregistrer jusqu'à 100 événements depuis un fichier JSON, et afficher lesquels ont été acceptés ou refusés |
| openemail events list-names | Les noms d'événements envoyés par l'espace de travail, pour en choisir un dans un déclencheur |
| openemail contacts list-events <email> | Les événements d'un contact, les plus récents en premier. --name limite la liste à un seul événement |
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.placedLes propriétés vont dans le corps JSON, envoyez donc un événement qui en a avec --data. Les événements sont conservés 90 jours.