Anleitung
Events aus Ihrem Backend senden
Erfassen Sie Workspace-Events und eigene Events von Ihren Servern mit der Events-API, einzeln oder gesammelt, mit einem reinen Event-Schlüssel.
Senden Sie Events von Ihren Servern für alles, was nicht vom Browser des Besuchers abhängen darf, etwa Bestellungen, Zahlungen, Abo-Änderungen oder Events aus einem Backoffice. Diese Seite zeigt, wie Sie ein Event senden, wie Sie viele senden und wie Sie mit Fehlern umgehen.
Voraussetzungen
- Das Senden von Events ist in den Tarifen Pro, Business und Custom enthalten. Ein Workspace mit Pro kann 100 Event-Typen nutzen, ein Workspace mit Business 1.000. Siehe Limits.
- Erstellen Sie unter Email APIAPI Keys einen API-Schlüssel mit dem Scope Events Only. Er kann Events senden und sonst nichts: Er kann Ihre Daten nicht lesen, keine Event-Definitionen verwalten und keine E-Mails senden. Ein Schlüssel mit Full Access funktioniert ebenfalls. Siehe API-Schlüssel.
- Um Workspace-Events zu senden, definieren Sie sie zuerst. Eigene Events brauchen keine Einrichtung.
Event senden
Rufen Sie Event senden mit dem type des Events, seinen properties und der Person auf, um die es geht:
curl -X POST https://api.emailit.com/v2/events \
-H "Authorization: Bearer $EMAILIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "c:order.completed",
"email": "jane@example.com",
"properties": { "order_id": "1001", "total": 59.9, "currency": "EUR" },
"occurred_at": "2026-10-19T09:30:00Z"
}'emailordnet das Event dem Kontakt mit dieser Adresse zu. Wenn Sie die ID des Kontakts bereits kennen, senden Sie stattdessencontact_id.occurred_atgibt an, wann es passiert ist, zum Beispiel wenn Sie Events aus einer Warteschlange senden. Lassen Sie das Feld weg, um die aktuelle Zeit zu verwenden.- Die Antwort ist
201mit dem gespeicherten Event und seinerevt_-ID. Ein reiner Event-Schlüssel erhält das Event ohnedatazurück.
Viele Events auf einmal senden
Events gesammelt senden nimmt bis zu 100 Events in einer Anfrage an und eignet sich damit für Importe und geplante Synchronisierungen:
curl -X POST https://api.emailit.com/v2/events/batch \
-H "Authorization: Bearer $EMAILIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"events": [
{ "type": "c:order.completed", "email": "jane@example.com", "properties": { "order_id": "1001", "total": 59.9 } },
{ "type": "c:order.completed", "email": "omar@example.com", "properties": { "order_id": "1002", "total": 18 } }
]
}'Ein Batch gilt ganz oder gar nicht: Ist ein Event ungültig, wird keines gespeichert. Die Antwort mit 422 führt jedes Problem unter events.<index> auf, sodass Sie diese Events korrigieren oder weglassen und den Batch erneut senden können.
Fehler behandeln
| Status | Bedeutung | Was zu tun ist |
|---|---|---|
201 |
Gespeichert. | Nichts. |
400 |
Der Body ist kein JSON-Objekt, oder der Batch ist leer oder enthält mehr als 100 Events. | Korrigieren Sie die Anfrage. |
401 |
Der API-Schlüssel fehlt oder ist falsch. | Prüfen Sie den Schlüssel. |
403 |
Der Scope des Schlüssels erlaubt kein Senden von Events, oder der Workspace ist im Tarif Pay as you go ("error": "plan_required"). |
Verwenden Sie einen reinen Event-Schlüssel oder einen Schlüssel mit Vollzugriff, oder wechseln Sie zu Pro oder Business. |
422 |
Ein Event ist ungültig: ein w:-Event, das nicht definiert ist, eine Eigenschaft mit falschem Typ, eine unbekannte contact_id, ein Datum, das mehr als 24 Stunden in der Zukunft liegt, oder ein neuer Event-Typ, wenn der Workspace bereits so viele Typen nutzt, wie sein Tarif umfasst. errors nennt jedes Feld. |
Korrigieren Sie das Event, oder wechseln Sie für mehr Event-Typen in einen höheren Tarif. Unverändert wiederholt schlägt es erneut fehl. |
5xx |
Ein vorübergehendes Problem bei Emailit. | Wiederholen Sie die Anfrage mit Backoff. |
Events haben keinen Idempotenzschlüssel. Wiederholen Sie eine Anfrage, die bereits durchgegangen ist, wird das Event also zweimal gespeichert. Legen Sie Ihre eigene ID in die Eigenschaften, etwa order_id, damit alle, die die Events lesen, Duplikate erkennen können.
Prüfen, ob Events ankommen
Öffnen Sie Email APIEvents. Der Tab Log listet neue Events oben auf; setzen Sie Scope auf Custom oder Workspace, um System-Events auszublenden. Wählen Sie ein Event aus, um seine Eigenschaften, den zugehörigen Kontakt und seine Herkunft zu sehen. Events, die einem Kontakt zugeordnet sind, erscheinen außerdem im Activity log des Kontakts.