Otomasyonlar ve olaylar
Otomasyonlar, içlerindeki kişiler ve onları ilerleten olaylar için her komut, uygulamalı örneklerle.
Her şey nasıl birbirine bağlanır
Bir otomasyon, bir tetikleyici ve bir adım ağacıdır. Bir taslak ve yayında bir sürüm tutar: update taslağı ve ayarları değiştirir, publish ise taslağı dondurur ve otomasyonu etkinleştirir. Okumak automations:read, değiştirmek automations:write gerektirir. publish, resume ve send-test ayrıca emails:send gerektirir, çünkü bunlar otomasyona posta gönderttirir.
openemail automations create --name "Welcome series" --starter welcome-seriesopenemail automations update aut_5c1e9a7b3d2f48e6a0b4c7d1 --data @welcome.jsonopenemail automations publish aut_5c1e9a7b3d2f48e6a0b4c7d1openemail automations stats aut_5c1e9a7b3d2f48e6a0b4c7d1Tanım JSON'dur, bu yüzden onu bir dosyaya yazın ve --data @file ile verin. openemail automations get <id> --json geçerli tanımı yazdırır, problems alanı ise yayımlanmasını hâlâ neyin engellediğini listeler.
Otomasyonlar
| Komut | Ne yapar |
|---|---|
| openemail automations list | Otomasyonların bir sayfası, en son değiştirilen önce. --status bunu draft, live, paused ya da archived ile daraltır |
| openemail automations create --name <value> | --starter ile, --data içindeki bir tanımla ya da boş bir taslak oluşturun |
| openemail automations get <id> | Taslağı, yayındaki sürümü, ayarları ve taslaktaki sorunlarıyla tek bir otomasyon |
| openemail automations update <id> | Adı, ayarları ya da taslak tanımını değiştirin. --expected-updated-at, siz okuduktan sonra yapılmış bir değişikliğin üzerine yazmayı reddeder |
| openemail automations publish <id> | Taslağı sonraki sürüm olarak dondurun ve otomasyonu etkinleştirin |
| openemail automations pause <id> | Yayındaki bir otomasyonu durdurun. İçerideki herkes olduğu yerde bekler |
| openemail automations resume <id> | Duraklatılmış bir otomasyonu, çalıştırdığı sürümle yeniden etkinleştirin |
| openemail automations archive <id> | Bir otomasyonu kalıcı olarak emekliye ayırın ve geçmişini koruyun. İçerideki herkes çıkar |
| openemail automations duplicate <id> | Bir otomasyonu, kişileri ve sayıları olmadan yeni bir taslağa kopyalayın |
| openemail automations delete <id> | Onayınızdan sonra bir otomasyonu ve geçmişini silin. Tarayıcı oturumu ayrıca doğrulama kodu ister |
| openemail automations list-starters | Yeni bir otomasyonun başlayabileceği başlangıç noktaları |
Test, sürümler ve sayılar
| Komut | Ne yapar |
|---|---|
| openemail automations send-test <id> --step-key <value> | Taslağın bir e-posta adımını örnek değerlerle kendinize ya da --to adresine gönderin. Kimseyi kaydetmez |
| openemail automations list-versions <id> | Yayımlanan her sürüm, en yenisi önce |
| openemail automations restore-version <id> <version> | Önceki bir sürümü taslağa geri kopyalayın. Çalışması için yayımlayın |
| openemail automations stats <id> | Toplamlar, her adım için bir satır ve her gün için bir nokta. --since zaman aralığının nerede başladığını belirler, varsayılan son 30 gündür |
Bir otomasyonun içindeki kişiler
| Komut | Ne yapar |
|---|---|
| openemail automations list-enrollments <id> | Giren kişiler, en yenisi önce, her birinin bulunduğu adımla. --status ve --step-key bunu daraltır, --all ise her sayfayı okur |
| openemail automations get-enrollment <id> <enrollment-id> | Bir kişinin yolculuğu, çalışan her adım ve her gönderimin ürettiği e-postayla birlikte |
| openemail automations enroll <id> --email <value> | Bir kişiyi yayındaki bir otomasyonun ilk adımına koyun. --contact-id kişiyi kimliğiyle belirtir |
| openemail automations exit-enrollment <id> <enrollment-id> | Birini bitirmeden önce çıkarma |
openemail automations list-enrollments aut_5c1e9a7b3d2f48e6a0b4c7d1 --status active --all --json | jq -r '.items[] | .contact.email + " " + (.stepKey // "")'Etkinlikler
Bir olay, bir kişinin ürününüzde bir şey yaptığını söyler. Tetikleyicisi onun adını veren yayındaki her otomasyonu başlatır ve onu bekleyen herkesi ilerletir. Bir olay göndermek contacts:write gerektirir.
| Komut | Ne yapar |
|---|---|
| openemail events send --name <value> --email <value> | Bir kişi için tek bir olay kaydedin. --create-contact, adres henüz kimsede yoksa kişiyi ekler, --idempotency-key ise yeniden denemeyi güvenli kılar |
| openemail events send-batch <events> | Bir JSON dosyasından en fazla 100 olay kaydedin ve hangilerinin kabul edildiğini, hangilerinin reddedildiğini yazdırın |
| openemail events list-names | Çalışma alanının gönderdiği olay adları, bir tetikleyicide birini seçmek için |
| openemail contacts list-events <email> | Bir kişinin olayları, en yenisi önce. --name bunu tek bir olaya daraltır |
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.placedÖzellikler JSON gövdesinde gider, bu yüzden özellikleri olan bir olayı --data ile gönderin. Olaylar 90 gün saklanır.