CLI
Automatizimet dhe ngjarjet
Çdo komandë për automatizimet, personat brenda tyre dhe ngjarjet që i lëvizin, me shembuj praktikë.
Si lidhet gjithçka
Një automatizim është një nisës dhe një pemë hapash. Ai mban një skicë dhe një version aktiv: update ndryshon skicën dhe cilësimet, dhe publish e ngrin skicën dhe e aktivizon automatizimin. Leximi kërkon automations:read dhe ndryshimi kërkon automations:write. publish, resume dhe send-test kërkojnë edhe emails:send, sepse e bëjnë automatizimin të dërgojë postë.
openemail automations create --name "Welcome series" --starter welcome-seriesopenemail automations update aut_5c1e9a7b3d2f48e6a0b4c7d1 --data @welcome.jsonopenemail automations publish aut_5c1e9a7b3d2f48e6a0b4c7d1openemail automations stats aut_5c1e9a7b3d2f48e6a0b4c7d1Përkufizimi është JSON, ndaj shkruajeni në një skedar dhe jepeni me --data @file. openemail automations get <id> --json shfaq atë aktual, dhe problems i tij liston çfarë ende e pengon të publikohet.
Automatizimet
| Komanda | Çfarë bën |
|---|---|
| openemail automations list | Një faqe e automatizimeve, nga i ndryshuari më së fundi. --status e ngushton në draft, live, paused ose archived |
| openemail automations create --name <value> | Krijoni një skicë nga --starter, nga një përkufizim në --data, ose një bosh |
| openemail automations get <id> | Një automatizim me skicën, versionin aktiv, cilësimet e tij dhe çfarë nuk shkon me skicën |
| openemail automations update <id> | Ndryshoni emrin, cilësimet ose përkufizimin e skicës. --expected-updated-at refuzon të mbishkruajë një ndryshim të bërë që kur e lexuat |
| openemail automations publish <id> | Ngrini skicën si versionin e radhës dhe aktivizoni automatizimin |
| openemail automations pause <id> | Ndaloni një automatizim aktiv. Të gjithë brenda qëndrojnë aty ku janë |
| openemail automations resume <id> | Riaktivizoni një automatizim të pezulluar me versionin që po ekzekutonte |
| openemail automations archive <id> | Tërhiqni përgjithmonë një automatizim dhe ruani historikun e tij. Të gjithë brenda dalin |
| openemail automations duplicate <id> | Kopjoni një automatizim në një skicë të re, pa personat dhe shifrat e tij |
| openemail automations delete <id> | Fshini një automatizim dhe historikun e tij pasi të konfirmoni. Një hyrje me shfletues kërkon edhe një kod verifikimi |
| openemail automations list-starters | Pikat e nisjes nga të cilat mund të fillojë një automatizim i ri |
Provat, versionet dhe shifrat
| Komanda | Çfarë bën |
|---|---|
| openemail automations send-test <id> --step-key <value> | Dërgoni një hap emaili të skicës te vetja, ose te --to, me vlera shembull. Nuk regjistron askënd |
| openemail automations list-versions <id> | Çdo version që është publikuar, më i riu i pari |
| openemail automations restore-version <id> <version> | Kopjoni një version të mëparshëm sërish në skicë. Publikojeni që të ekzekutohet |
| openemail automations stats <id> | Totalet, një rresht për çdo hap dhe një pikë për çdo ditë. --since cakton ku fillon periudha, dhe si parazgjedhje janë 30 ditët e fundit |
Personat brenda një automatizimi
| Komanda | Çfarë bën |
|---|---|
| openemail automations list-enrollments <id> | Personat që hynë, më të rinjtë në krye, me hapin ku ndodhet secili. --status dhe --step-key e ngushtojnë, dhe --all lexon çdo faqe |
| openemail automations get-enrollment <id> <enrollment-id> | Rrugëtimi i një personi, me çdo hap që u ekzekutua dhe emailin që prodhoi çdo dërgim |
| openemail automations enroll <id> --email <value> | Futni një kontakt në një automatizim aktiv te hapi i tij i parë. --contact-id e tregon kontaktin me id |
| openemail automations exit-enrollment <id> <enrollment-id> | Nxirrni dikë para se të përfundojë |
openemail automations list-enrollments aut_5c1e9a7b3d2f48e6a0b4c7d1 --status active --all --json | jq -r '.items[] | .contact.email + " " + (.stepKey // "")'Ngjarjet
Një ngjarje thotë se një kontakt bëri diçka në produktin tuaj. Ajo nis çdo automatizim aktiv, nisësi i të cilit e emërton, dhe çon përpara këdo që po e priste. Dërgimi i saj kërkon contacts:write.
| Komanda | Çfarë bën |
|---|---|
| openemail events send --name <value> --email <value> | Regjistroni një ngjarje për një kontakt. --create-contact e shton kontaktin kur askush nuk e ka ende atë adresë, dhe --idempotency-key e bën të sigurt një riprovë |
| openemail events send-batch <events> | Regjistroni deri në 100 ngjarje nga një skedar JSON, dhe shfaqni cilat u pranuan e cilat u refuzuan |
| openemail events list-names | Emrat e ngjarjeve që ka dërguar hapësira e punës, për të zgjedhur një te një nisës |
| openemail contacts list-events <email> | Ngjarjet e një kontakti, më të rejat në krye. --name e ngushton në një ngjarje |
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.placedVetitë shkojnë në trupin JSON, ndaj një ngjarje që i ka dërgojeni me --data. Ngjarjet mbahen 90 ditë.