Zum Hauptinhalt springen

Events & Payload

Unterstützte Events (Stand heute)​

Aktuell unterstützt intraOnline folgende Webhook-Events:

  • EVENT_CREATE: Wird ausgelöst, wenn ein Event angelegt wird.
  • ANNOUNCMENT_PUBLISHED: Wird ausgelöst, wenn eine Mitteilung veröffentlicht wird (bei Erstellung als „published“ oder beim Wechsel von „draft“ zu „published“).

Die verfügbaren Events wählen Sie in der WebApp beim Anlegen/Bearbeiten eines Webhooks aus.

Collection (optional)​

Zusätzlich zum eventType können Sie optional Collection (optional) als Filter verwenden.

  • In der Regel können Sie dieses Feld leer lassen.
  • Ein Wert wird nur in Sonderfällen benötigt, um ein Event zusätzlich einzuschränken.

Request-Header​

Bei jeder Zustellung setzt intraOnline System-Header:

  • X-Event-Id: Eindeutige ID der Zustellung (für Idempotenz/Deduplizierung)
  • X-Event-Type: Das Event (z. B. EVENT_CREATE)
  • Content-Type: Abhängig vom Payload-Format bzw. der Konfiguration
  • optional X-Signature: HMAC-Signatur (wenn ein Secret gesetzt ist)

Signatur (HMAC)​

Wenn Sie ein Secret hinterlegen, wird jede Zustellung signiert. Die Signatur wird im Header X-Signature übertragen.

Wichtig:

  • Signiert wird der exakte Request-Body, so wie er gesendet wird.
  • Prüfen Sie die Signatur auf Ihrer Empfängerseite, bevor Sie den Payload verarbeiten.

Request-Body ohne Template (Standard)​

Wenn kein Body-Template gesetzt ist, sendet intraOnline standardmäßig einen JSON-Body mit folgendem Schema:

{
  "eventType": "EVENT_CREATE",
  "documentId": "…",
  "event": { "…" : "…" }
}

Hinweise:

  • Die enthaltenen Felder hängen vom jeweiligen Event ab.
  • Aus Sicherheits- und Datenschutzgründen werden nicht zwangsläufig alle internen Felder übertragen.

Individuelles Payload (optional)​

Sie können den Request-Body optional über ein Body-Template anpassen.

Empfehlung:

  • Nutzen Sie die Funktion „Template-Variablen“ in der WebApp, um verfügbare Variablen einzusehen und einzufügen.
  • Wenn Sie das Payload-Format auf json setzen, sollte Ihr Template als Ergebnis gültiges JSON erzeugen.

Verfügbare Variablen​

Welche Variablen verfügbar sind, hängt vom Event ab. Sie können diese in der WebApp im Bereich „Template-Variablen“ einsehen.

Wenn Sie unsicher sind, starten Sie mit dem Standard-Payload (ohne Template) und passen Sie nur bei Bedarf an.

Siehe auch​

  • Webhooks — Überblick über das Modul
  • API-Token — technischer Zugriff ohne Passwort
  • Verwaltung — zentrale Einstellungen der Organisation