Reference
Typy událostí
Všechny typy webhookových událostí, které Emailit odesílá: kdy která nastane, jaký objekt nese a které typy ve výběru událostí ve webovém rozhraní chybí.
Toto je úplný seznam typů událostí, které Emailit odesílá na webhooky a zaznamenává do proudu událostí. Pole data.object každé události obsahuje zdroj, kterého se událost týká; sloupec Objekt ukazuje jeho hodnotu object. Kliknutím na název události zobrazíte její úplný obsah, pokud pro ni existuje referenční stránka.
Webhook se zapnutým All events dostává všechny typy níže. Když vybíráte události ve webovém rozhraní, některé typy ve výběru nejsou; jsou označené „Není ve výběru“ a můžete je přidat přes endpoint Úprava webhooku.
Události e-mailů
| Událost | Objekt | Kdy nastane |
|---|---|---|
email.accepted |
email |
E-mail odeslaný přes API nebo formulář Compose byl přijat a zařazen do fronty. U SMTP se neodesílá. |
email.scheduled |
email |
Uložil se e-mail z API s budoucím scheduled_at. Obsahuje scheduled_at. |
email.delivered |
email |
Poštovní server příjemce zprávu přijal. |
email.attempted |
email |
Pokus o doručení dočasně selhal a zopakuje se. Odesílá se při každém pokusu; obsahuje smtp_code, smtp_enhanced_code a smtp_response. |
email.bounced |
email |
Doručení trvale selhalo, po doručení přišla zpráva o nedoručení nebo se vyčerpaly pokusy o doručení. |
email.failed |
email |
Zpracování selhalo kvůli chybě, ne kvůli odpovědi serveru příjemce. Vzácné. |
email.rejected |
email |
Emailit odmítl odeslat e-mail příjemci, protože workspace není ověřený. |
email.suppressed |
email |
Příjemce je na seznamu blokovaných adres, takže se e-mail neodeslal. |
email.held |
email |
E-mail byl zadržen a neodeslal se: zablokovaný workspace, pozastavená doména, nedostatek kreditů, skóre spamu 7 nebo vyšší nebo API klíč nastavený na zadržování. Není ve výběru. |
email.canceled |
email |
E-mail byl zrušen ve webovém rozhraní nebo přes API. Obsahuje status a previous_status. Není ve výběru. |
email.received |
email |
Na vaši příchozí subdoménu dorazila zpráva. Nese jen id, from, to, subject a created_at. |
email.complained |
email |
Příjemce nahlásil e-mail jako spam přes feedback loop svého poskytovatele. |
email.loaded |
load |
Načetl se měřicí obrázek. Odesílá se při každém načtení, nejen při prvním. |
email.clicked |
click |
Někdo klikl na měřený odkaz. Odesílá se při každém prokliku; obsahuje link.url. |
email.unsubscribed |
email |
Příjemce se odhlásil odkazem nebo stránkou pro odhlášení v e-mailu z kampaně. Obsahuje campaign, contact a unsubscribed_at. Není ve výběru. |
email.resubscribed |
email |
Příjemce se znovu přihlásil na odhlašovací stránce. Obsahuje campaign, contact a resubscribed_at. Není ve výběru. |
Události stavu e-mailu (email.accepted až email.complained výše) nesou id, from, to, subject, status a meta e-mailu a k tomu časová razítka. Události prokliku a načtení nesou vlastní id, email_id, vnořený objekt email (rcpt_to, mail_from, subject, campaign, meta), odpovídající contact, pokud existuje, ip_address a user_agent. Význam jednotlivých stavů najdete na stránce Stavy e-mailů.
Události domén
| Událost | Objekt | Kdy nastane |
|---|---|---|
domain.created |
domain |
Byla přidána odesílací doména. |
domain.updated |
domain |
Změnilo se nastavení domény, například měření nebo klíč subdomény. Výsledky ověření DNS tuto událost nevyvolávají. |
domain.deleted |
domain |
Doména byla smazána. |
Události seznamů a odběratelů
| Událost | Objekt | Kdy nastane |
|---|---|---|
audience.created |
audience |
Byl vytvořen seznam kontaktů. |
audience.updated |
audience |
Seznam kontaktů byl přejmenován. |
audience.deleted |
audience |
Seznam kontaktů byl smazán. |
subscriber.created |
subscriber |
Kontakt byl přidán do seznamu kontaktů. |
subscriber.updated |
subscriber |
Odběratel se změnil, včetně odhlášení ze seznamu a opětovného přihlášení. |
subscriber.deleted |
subscriber |
Kontakt byl odebrán ze seznamu kontaktů, a to i při smazání kontaktu. |
subscriber.resubscribed |
subscriber |
Odhlášený kontakt byl znovu přidán do seznamu kontaktů. Odesílá se spolu s událostí subscriber.updated. Není ve výběru. |
Objekty odběratelů obsahují subscribed, subscribed_at, unsubscribed_at, audience (id, name) a contact (id, email, jména a vlastní pole).
Události kontaktů, šablon a blokovaných adres
| Událost | Objekt | Kdy nastane |
|---|---|---|
contact.created |
contact |
Byl vytvořen kontakt. |
contact.updated |
contact |
Změnila se pole kontaktu, jeho vlastní pole nebo seznamy kontaktů. |
contact.deleted |
contact |
Kontakt byl smazán. |
template.created |
template |
Byla vytvořena šablona nebo nová verze šablony. |
template.updated |
template |
Šablona byla upravena nebo publikována. |
template.deleted |
template |
Šablona byla smazána. |
suppression.created |
suppression |
Blokace byla přidána ve webovém rozhraní, přes API, importem CSV nebo automatizací. |
suppression.updated |
suppression |
Změnil se důvod blokace nebo doba jejího vypršení. |
suppression.deleted |
suppression |
Blokace byla odebrána. |
Blokace, které doručovací proces přidá automaticky po nedoručení nebo stížnosti, událost suppression.created nevyvolávají. Pokud je chcete sledovat, poslouchejte události email.bounced a email.complained.
Události ověřování e-mailů
| Událost | Objekt | Kdy nastane |
|---|---|---|
email_verification.created |
email_verification |
Bylo vyžádáno ověření jedné adresy. |
email_verification.updated |
email_verification |
Ověření skončilo a jeho výsledek je k dispozici. |
email_verification_list.created |
email_verification_list |
Byl vytvořen seznam k ověření. |
email_verification_list.updated |
email_verification_list |
Zpracování seznamu skončilo. Obsahuje status a stats. |
Výběr událostí ve webovém rozhraní uvádí také email_verification.deleted a email_verification_list.deleted. Tyto události Emailit neodesílá.
Události kampaní
Události kampaní ve výběru ve webovém rozhraní nejsou. Dostanou je webhooky se zapnutým All events, nebo je můžete přidat přes API. Každá nese objekt campaign s poli id, name, status, subject, from_email, from_name, scheduled_at, sent_at a created_at. Změny stavu obsahují také previous_status.
| Událost | Kdy nastane |
|---|---|
campaign.created |
Byla vytvořena kampaň. |
campaign.updated |
Změnil se obsah, odesílatel nebo příjemci kampaně. |
campaign.deleted |
Kampaň byla smazána. |
campaign.scheduled |
Kampaň byla naplánována na pozdější čas. |
campaign.queued |
Naplánovaná kampaň dosáhla času odeslání a byla zařazena do fronty. |
campaign.sending |
Kampaň se začala odesílat. |
campaign.testing |
Kampaň přešla do stavu testing. |
campaign.sent |
Odesílání kampaně skončilo. |
campaign.canceled |
Kampaň byla zrušena. |
campaign.archived |
Kampaň byla archivována. |
Zastaralé názvy událostí
Skupina Deprecated ve výběru ve webovém rozhraní uvádí názvy ze starší verze Emailitu: email.sent, email.opened, email.softfail, email.hardfail, email.error, email.delayed a email.processed. Tyto události se už neodesílají. Místo nich používejte email.delivered, email.loaded, email.attempted a email.bounced.