ऑटोमेशन और इवेंट
ऑटोमेशन, उनके अंदर के लोगों और उन्हें आगे बढ़ाने वाले इवेंट की हर कमांड, काम करते उदाहरणों के साथ।
यह सब आपस में कैसे जुड़ता है
ऑटोमेशन एक ट्रिगर और चरणों का एक ट्री है। इसमें एक ड्राफ़्ट और एक लाइव संस्करण रहता है: update ड्राफ़्ट और सेटिंग्स बदलता है, और publish ड्राफ़्ट को स्थिर करके ऑटोमेशन चालू करता है। पढ़ने के लिए automations:read और बदलने के लिए automations:write चाहिए। publish, resume और send-test के लिए emails:send भी चाहिए, क्योंकि इनसे ऑटोमेशन मेल भेजता है।
openemail automations create --name "Welcome series" --starter welcome-seriesopenemail automations update aut_5c1e9a7b3d2f48e6a0b4c7d1 --data @welcome.jsonopenemail automations publish aut_5c1e9a7b3d2f48e6a0b4c7d1openemail automations stats aut_5c1e9a7b3d2f48e6a0b4c7d1परिभाषा JSON है, इसलिए इसे किसी फ़ाइल में लिखें और --data @file के साथ दें। openemail automations get <id> --json मौजूदा परिभाषा दिखाता है, और उसका problems बताता है कि अभी क्या उसे प्रकाशित होने से रोक रहा है।
ऑटोमेशन
| कमांड | यह क्या करता है |
|---|---|
| openemail automations list | ऑटोमेशन का एक पेज, सबसे हाल में बदले गए पहले। --status इसे draft, live, paused या archived तक सीमित करता है |
| openemail automations create --name <value> | --starter से, --data में दी परिभाषा से, या ख़ाली ड्राफ़्ट बनाएँ |
| openemail automations get <id> | एक ऑटोमेशन, उसके ड्राफ़्ट, लाइव संस्करण, सेटिंग्स और ड्राफ़्ट की गड़बड़ियों के साथ |
| openemail automations update <id> | नाम, सेटिंग्स या ड्राफ़्ट की परिभाषा बदलें। --expected-updated-at आपके पढ़ने के बाद हुए बदलाव को मिटाकर लिखने से मना करता है |
| openemail automations publish <id> | ड्राफ़्ट को अगले संस्करण के रूप में स्थिर करें और ऑटोमेशन चालू करें |
| openemail automations pause <id> | लाइव ऑटोमेशन रोकें। अंदर के सभी लोग जहाँ हैं वहीं रुके रहते हैं |
| openemail automations resume <id> | रोके गए ऑटोमेशन को उसी संस्करण के साथ फिर चालू करें जो चल रहा था |
| openemail automations archive <id> | ऑटोमेशन को हमेशा के लिए बंद करें और उसका इतिहास रखें। अंदर के सभी लोग बाहर हो जाते हैं |
| openemail automations duplicate <id> | ऑटोमेशन को नए ड्राफ़्ट में कॉपी करें, उसके लोगों और आँकड़ों के बिना |
| openemail automations delete <id> | आपकी पुष्टि के बाद ऑटोमेशन और उसका इतिहास हटाएँ। ब्राउज़र साइन-इन पर सत्यापन कोड भी माँगा जाता है |
| openemail automations list-starters | वे शुरुआती ढाँचे जिनसे नया ऑटोमेशन शुरू हो सकता है |
टेस्ट, संस्करण और आँकड़े
| कमांड | यह क्या करता है |
|---|---|
| openemail automations send-test <id> --step-key <value> | ड्राफ़्ट का एक ईमेल चरण नमूना मानों के साथ ख़ुद को, या --to पर भेजें। इससे कोई नहीं जुड़ता |
| openemail automations list-versions <id> | प्रकाशित हुआ हर संस्करण, सबसे नया पहले |
| openemail automations restore-version <id> <version> | किसी पुराने संस्करण को वापस ड्राफ़्ट में कॉपी करें। उसे चलाने के लिए प्रकाशित करें |
| openemail automations stats <id> | कुल योग, हर चरण की एक पंक्ति और हर दिन का एक बिंदु। --since तय करता है कि अवधि कहाँ से शुरू हो, और डिफ़ॉल्ट पिछले 30 दिन हैं |
ऑटोमेशन के अंदर के लोग
| कमांड | यह क्या करता है |
|---|---|
| openemail automations list-enrollments <id> | अंदर आए लोग, नए पहले, और हर एक जिस चरण पर है। --status और --step-key इसे सीमित करते हैं, और --all हर पेज पढ़ता है |
| openemail automations get-enrollment <id> <enrollment-id> | एक व्यक्ति की भागीदारी, उसमें चले हर चरण और हर बार भेजे गए ईमेल के साथ |
| openemail automations enroll <id> --email <value> | एक संपर्क को लाइव ऑटोमेशन के पहले चरण पर डालें। --contact-id संपर्क को id से बताता है |
| openemail automations exit-enrollment <id> <enrollment-id> | किसी को पूरा करने से पहले बाहर निकालें |
openemail automations list-enrollments aut_5c1e9a7b3d2f48e6a0b4c7d1 --status active --all --json | jq -r '.items[] | .contact.email + " " + (.stepKey // "")'इवेंट
इवेंट बताता है कि किसी संपर्क ने आपके प्रोडक्ट में कुछ किया। यह हर उस लाइव ऑटोमेशन को शुरू करता है जिसके ट्रिगर में इसका नाम है, और जो कोई इसका इंतज़ार कर रहा था उसे आगे बढ़ाता है। इसे भेजने के लिए contacts:write चाहिए।
| कमांड | यह क्या करता है |
|---|---|
| openemail events send --name <value> --email <value> | किसी संपर्क के लिए एक इवेंट दर्ज करें। --create-contact संपर्क को तब जोड़ता है जब वह पता अभी किसी का नहीं है, और --idempotency-key दोबारा कोशिश को सुरक्षित बनाता है |
| openemail events send-batch <events> | JSON फ़ाइल से अधिकतम 100 इवेंट दर्ज करें, और दिखाएँ कि कौन से स्वीकार हुए और कौन से मना किए गए |
| openemail events list-names | वे इवेंट नाम जो वर्कस्पेस ने भेजे हैं, ताकि ट्रिगर में कोई एक चुना जा सके |
| openemail contacts list-events <email> | एक संपर्क के इवेंट, नए पहले। --name इसे एक इवेंट तक सीमित करता है |
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प्रॉपर्टी JSON बॉडी में जाती हैं, इसलिए जिस इवेंट में वे हों उसे --data के साथ भेजें। इवेंट 90 दिनों तक रखे जाते हैं।