Referenz
Event-Typen
Alle Webhook-Event-Typen, die Emailit sendet, wann jeder ausgelöst wird, welches Objekt er enthält und welche Typen die Auswahl in der Weboberfläche auslässt.
Dies ist die vollständige Liste der Event-Typen, die Emailit an Webhooks sendet und im Event-Stream aufzeichnet. Das Feld data.object jedes Events enthält die Ressource, um die es geht; die Spalte Objekt zeigt ihren Wert für object. Wählen Sie einen Event-Namen, um den vollständigen Payload zu sehen, sofern es eine Referenzseite gibt.
Ein Webhook, bei dem All events aktiviert ist, erhält alle unten aufgeführten Typen. Wenn Sie Events in der Weboberfläche auswählen, fehlen einige Typen in der Auswahl; sie sind mit „Nicht in der Auswahl“ gekennzeichnet, und Sie können sie mit Webhook aktualisieren hinzufügen.
E-Mail-Events
| Event | Objekt | Wann es ausgelöst wird |
|---|---|---|
email.accepted |
email |
Eine per API oder mit Compose gesendete E-Mail wurde angenommen und in die Warteschlange gestellt. Nicht bei SMTP. |
email.scheduled |
email |
Eine API-E-Mail mit einem zukünftigen scheduled_at wurde gespeichert. Enthält scheduled_at. |
email.delivered |
email |
Der Mailserver des Empfängers hat die Nachricht angenommen. |
email.attempted |
email |
Ein Zustellversuch ist vorübergehend fehlgeschlagen und wird wiederholt. Wird bei jedem Versuch gesendet; enthält smtp_code, smtp_enhanced_code und smtp_response. |
email.bounced |
email |
Die Zustellung ist dauerhaft fehlgeschlagen, nach der Zustellung ist eine Bounce-Meldung eingetroffen oder die Wiederholungsversuche sind ausgeschöpft. |
email.failed |
email |
Die Verarbeitung ist wegen eines Fehlers fehlgeschlagen, nicht wegen einer Antwort des Empfangsservers. Selten. |
email.rejected |
email |
Emailit hat den Versand an einen Empfänger verweigert, weil der Workspace nicht verifiziert ist. |
email.suppressed |
email |
Der Empfänger steht auf der Sperrliste, daher wurde die E-Mail nicht gesendet. |
email.held |
email |
Die E-Mail wurde zurückgehalten und nicht gesendet: gesperrter Workspace, pausierte Domain, nicht genug Credits, Spam-Score von 7 oder mehr oder ein auf Zurückhalten eingestellter API-Schlüssel. Nicht in der Auswahl. |
email.canceled |
email |
Die E-Mail wurde in der Weboberfläche oder per API storniert. Enthält status und previous_status. Nicht in der Auswahl. |
email.received |
email |
Eine Nachricht ist auf Ihrer Inbound-Subdomain eingegangen. Enthält nur id, from, to, subject und created_at. |
email.complained |
email |
Der Empfänger hat die E-Mail über den Feedback-Loop seines Anbieters als Spam gemeldet. |
email.loaded |
load |
Das Tracking-Bild wurde geladen. Wird bei jedem Ladevorgang gesendet, nicht nur beim ersten. |
email.clicked |
click |
Ein getrackter Link wurde angeklickt. Wird bei jedem Klick gesendet; enthält link.url. |
email.unsubscribed |
email |
Ein Empfänger hat sich über den Abmeldelink oder die Abmeldeseite einer Kampagnen-E-Mail abgemeldet. Enthält campaign, contact und unsubscribed_at. Nicht in der Auswahl. |
email.resubscribed |
email |
Ein Empfänger hat sich über die Abmeldeseite erneut angemeldet. Enthält campaign, contact und resubscribed_at. Nicht in der Auswahl. |
E-Mail-Status-Events (oben email.accepted bis email.complained) enthalten id, from, to, subject, status und meta der E-Mail sowie Zeitstempel. Klick- und Lade-Events enthalten ihre eigene id, die email_id, ein verschachteltes Objekt email (rcpt_to, mail_from, subject, campaign, meta), den passenden contact, sofern vorhanden, ip_address und user_agent. Was die einzelnen E-Mail-Status bedeuten, erfahren Sie unter E-Mail-Status.
Domain-Events
| Event | Objekt | Wann es ausgelöst wird |
|---|---|---|
domain.created |
domain |
Eine Versanddomain wurde hinzugefügt. |
domain.updated |
domain |
Die Einstellungen einer Domain haben sich geändert, etwa das Tracking oder ein Subdomain-Schlüssel. Ergebnisse der DNS-Verifizierung lösen dieses Event nicht aus. |
domain.deleted |
domain |
Eine Domain wurde gelöscht. |
Kontaktlisten- und Abonnenten-Events
| Event | Objekt | Wann es ausgelöst wird |
|---|---|---|
audience.created |
audience |
Eine Kontaktliste wurde erstellt. |
audience.updated |
audience |
Eine Kontaktliste wurde umbenannt. |
audience.deleted |
audience |
Eine Kontaktliste wurde gelöscht. |
subscriber.created |
subscriber |
Ein Kontakt wurde zu einer Kontaktliste hinzugefügt. |
subscriber.updated |
subscriber |
Ein Abonnent hat sich geändert, auch durch Abmeldung von der Kontaktliste oder erneute Anmeldung. |
subscriber.deleted |
subscriber |
Ein Kontakt wurde aus einer Kontaktliste entfernt, auch wenn der Kontakt gelöscht wurde. |
subscriber.resubscribed |
subscriber |
Ein abgemeldeter Kontakt wurde wieder zur Kontaktliste hinzugefügt. Wird zusammen mit subscriber.updated gesendet. Nicht in der Auswahl. |
Abonnenten-Objekte enthalten subscribed, subscribed_at, unsubscribed_at, die audience (id, name) und den contact (id, email, Namen und eigene Felder).
Kontakt-, Vorlagen- und Sperrungs-Events
| Event | Objekt | Wann es ausgelöst wird |
|---|---|---|
contact.created |
contact |
Ein Kontakt wurde erstellt. |
contact.updated |
contact |
Felder, eigene Felder oder Kontaktlisten eines Kontakts haben sich geändert. |
contact.deleted |
contact |
Ein Kontakt wurde gelöscht. |
template.created |
template |
Eine Vorlage oder eine neue Vorlagenversion wurde erstellt. |
template.updated |
template |
Eine Vorlage wurde bearbeitet oder veröffentlicht. |
template.deleted |
template |
Eine Vorlage wurde gelöscht. |
suppression.created |
suppression |
Eine Sperrung wurde in der Weboberfläche, per API, per CSV-Import oder durch eine Automatisierung angelegt. |
suppression.updated |
suppression |
Grund oder Ablauf einer Sperrung haben sich geändert. |
suppression.deleted |
suppression |
Eine Sperrung wurde entfernt. |
Sperrungen, die die Zustell-Pipeline nach einem Bounce oder einer Beschwerde automatisch anlegt, lösen kein suppression.created aus. Um diese zu verfolgen, abonnieren Sie email.bounced und email.complained.
E-Mail-Verifizierungs-Events
| Event | Objekt | Wann es ausgelöst wird |
|---|---|---|
email_verification.created |
email_verification |
Eine Einzelverifizierung wurde angefordert. |
email_verification.updated |
email_verification |
Eine Verifizierung ist abgeschlossen und ihr Ergebnis liegt vor. |
email_verification_list.created |
email_verification_list |
Eine Verifizierungsliste wurde erstellt. |
email_verification_list.updated |
email_verification_list |
Die Verarbeitung einer Liste ist abgeschlossen. Enthält status und stats. |
Die Auswahl in der Weboberfläche listet außerdem email_verification.deleted und email_verification_list.deleted auf. Emailit sendet diese Events nicht.
Kampagnen-Events
Kampagnen-Events stehen nicht in der Auswahl der Weboberfläche. Sie erreichen Webhooks, bei denen All events aktiviert ist, oder Sie fügen sie per API hinzu. Jedes enthält ein Objekt vom Typ campaign mit id, name, status, subject, from_email, from_name, scheduled_at, sent_at und created_at. Statusänderungen enthalten zusätzlich previous_status.
| Event | Wann es ausgelöst wird |
|---|---|
campaign.created |
Eine Kampagne wurde erstellt. |
campaign.updated |
Inhalt, Absender oder Empfänger einer Kampagne haben sich geändert. |
campaign.deleted |
Eine Kampagne wurde gelöscht. |
campaign.scheduled |
Eine Kampagne wurde für einen späteren Zeitpunkt geplant. |
campaign.queued |
Eine geplante Kampagne hat ihren Sendezeitpunkt erreicht und wurde in die Warteschlange gestellt. |
campaign.sending |
Der Versand einer Kampagne hat begonnen. |
campaign.testing |
Eine Kampagne ist in den Status testing gewechselt. |
campaign.sent |
Der Versand einer Kampagne ist abgeschlossen. |
campaign.canceled |
Eine Kampagne wurde storniert. |
campaign.archived |
Eine Kampagne wurde archiviert. |
Veraltete Event-Namen
Die Gruppe Deprecated in der Auswahl der Weboberfläche listet Namen aus einer älteren Version von Emailit auf: email.sent, email.opened, email.softfail, email.hardfail, email.error, email.delayed und email.processed. Sie werden nicht mehr gesendet. Verwenden Sie stattdessen email.delivered, email.loaded, email.attempted und email.bounced.