Princip
Sledování událostí
Zaznamenávejte, co lidé dělají ve vaší aplikaci a na vašem webu, jako události workspace nebo vlastní události, propojte je s kontakty a přijímejte je ve webhoocích.
Sledování událostí vám umožní zaznamenávat, co lidé dělají ve vašem vlastním produktu: objednávku, změnu tarifu, registraci, zobrazení produktu. Události odesíláte z webu sledovacím skriptem, nebo ze svých serverů přes API. Emailit je ukládá vedle událostí, které zaznamenává sám, propojuje je s kontakty a může je odesílat na vaše webhooky.
Sledování událostí je součástí tarifů Pro, Business a Custom. V tarifu Pay as you go vracejí odesílání událostí a definování událostí workspace 403 s "error": "plan_required" a požadavky sledovacího skriptu se odmítají.
Tři rozsahy událostí
Každá událost má typ a jeho předpona určuje její rozsah:
| Rozsah | Typ | Kdo je definuje | Příklad |
|---|---|---|---|
| Systémové události | <name> |
Emailit. Zaznamenávají, co se děje s vašimi e-maily, kontakty a dalšími zdroji. Nemůžete je odesílat. | email.delivered |
| Události workspace | w:<name> |
Váš workspace. Nejdřív deklarujete událost a typ každé její vlastnosti a Emailit odmítne události, které definici neodpovídají. | w:customer.type |
| Vlastní události | c:<name> |
Nikdo. Libovolný název a jako vlastnosti libovolný objekt JSON. | c:order.completed |
Událost workspace použijte, když stejnou událost odesílá několik systémů a chcete, aby zůstala jednotná, nebo když se na její pole spoléhají lidé ve vašem týmu. Vlastní událost použijte, když chcete zachovat vlastní strukturu dat, například formát objednávek vašeho e-shopu, bez předchozí deklarace. Můžete začít s vlastní událostí a později ji definovat jako událost workspace; jde o dva samostatné typy, takže se c:order.completed a w:order.completed nemíchají.
Názvy událostí
Názvy mají 1 až 100 znaků (písmena, číslice, tečky, pomlčky nebo podtržítka) a začínají písmenem nebo číslicí: customer.type, order-completed, cart_updated. V názvech se rozlišují velká a malá písmena.
Názvy vlastností událostí workspace se řídí stejnými pravidly, jen bez teček, protože filtry webhooků a šablony používají tečky k přístupu k vnořeným hodnotám.
Jak události odesílat
| Odkud | Jak | Přístupové údaje |
|---|---|---|
| Z vašeho webu | Sledovací skript | Veřejný sledovací klíč omezený na vaše weby |
| Z vašich serverů | Odeslání události nebo Dávkové odeslání událostí | API klíč s oprávněním Full Access nebo Events Only. Viz Odesílání událostí z backendu. |
| Z webového rozhraní | Send event na stránce Email APIEvents | Vaše přihlášení. Určené k testování webhooku nebo integrace. |
Události týkající se peněz, například objednávky a platby, je nejlepší odesílat z vašich serverů. Události z prohlížeče mohou být zablokované a s veřejným klíčem může události odesílat kdokoli.
Události a kontakty
Událost může určit člověka, kterého se týká, pomocí pole email, nebo contact_id.
- Kontakty se dohledávají, nikdy se nevytvářejí. Pokud žádný kontakt danou e-mailovou adresu nemá, adresa se i tak uloží a událost se zobrazí v aktivitě kontaktu, jakmile ho vytvoříte.
- Hodnota
contact_idmusí patřit kontaktu ve workspace. - Události bez konkrétního člověka mohou nést
anonymous_id. Sledovací skript ho přidává ke každé události, kterou odešle.
Události propojené s kontaktem se zobrazují v panelu Activity log kontaktu vedle e-mailů, které kontakt dostal. Události workspace, které mají zobrazovaný název, se tam ukazují pod ním.
Kam se události dostanou
- Log událostí. Stránka Email APIEvents vypisuje všechny události na kartě Log. Filtrem Scope zobrazíte jen systémové události, události workspace nebo vlastní události. Přes API použijte parametr
scopeendpointu Výpis událostí. - Webhooky. Nechte webhook odebírat konkrétní typ, například
c:order.completed, nebo pomocíw:*ac:*všechny události workspace či všechny vlastní události. Webhook se zapnutým All events je nedostane, pokud je nevyberete i zvlášť. Viz Typy událostí. - Kontakty. Viz Události a kontakty.
- Automatizace. Spouštěč Custom event zahájí spuštění pro kontakt události, volitelně jen tehdy, když odpovídají její vlastnosti. Tytéž události mohou také ukončit spuštění, splnit cíl a posunout dál spuštění čekající v kroku Wait until. Dělají to jen události, které posíláte ze serveru přes API událostí: kdokoli s vaším veřejným sledovacím klíčem může návštěvníka identifikovat jako kohokoli, takže události ze sledovacího skriptu se zaznamenají a dostanou je webhooky, ale spuštění nezahajují, neukončují ani neposouvají dál. Spouštěč Custom event je součástí tarifů Business a Custom; podmínky ukončení, cíle a čekání na tyto události jsou součástí tarifů Pro, Business a Custom. Viz Podmínky ukončení a cíle.
Uchovávání
Události patří do kategorie Logs vašeho workspace, takže se uchovávají po dobu uchovávání logů ve vašem tarifu a pak se smažou. Viz Uchovávání dat. Objednávky a další záznamy, které potřebujete déle, uchovávejte ve svých systémech.
Limity
| Pay as you go | Pro | Business | Custom | |
|---|---|---|---|---|
| Typy událostí workspace a vlastních událostí | — | 100 | 1 000 | Neomezeně |
| Sledovací skript pro web | — | V ceně | V ceně | V ceně |
- Typy událostí jsou různé typy událostí workspace a vlastních událostí, které workspace odesílá, například
c:order.completedaw:customer.type. Typy, které už dřív odeslal, fungují dál. Jakmile vyčerpá počet typů svého tarifu, události nového typu se odmítnou s kódem422. - Události workspace: tolik, kolik typů událostí zahrnuje tarif, každá až s 50 vlastnostmi.
- U vlastních událostí mohou mít vlastnosti nejvýše 32 KB JSON a nejvýše 8 úrovní vnoření.
- Nejvýše 100 událostí v jednom dávkovém požadavku.
- Nejvýše 25 sledovacích klíčů v jednom workspace.
Více na stránce Limity a kvóty.