Zum Hauptinhalt springen

Einrichten

Berechtigungen​

RolleErlaubtBemerkung
User❌Kein Zugriff auf das Erstellen/Bearbeiten von Webhooks
Editor❌Kein Zugriff auf das Erstellen/Bearbeiten von Webhooks
Admin✅Webhooks anlegen, bearbeiten und löschen

Voraussetzungen​

  • Ihre Ziel-URL muss öffentlich erreichbar sein (http/https).
  • Die Ziel-URL darf keine Zugangsdaten (User/Pass) in der URL enthalten.
  • Die Ziel-URL darf nicht auf interne Netze (z. B. localhost, .local, private IPs) zeigen.
  • Ihr Endpoint sollte in der Regel innerhalb von 10 Sekunden mit einem 2xx-Status antworten.

WebApp: Webhook anlegen​

  1. Öffnen Sie Integrationen → Webhooks.
  2. Klicken Sie auf „Neuer Webhook“.
  3. Wählen Sie das Event, das den Webhook auslösen soll.
  4. Optional: Vergeben Sie einen Namen zur besseren Wiedererkennung.
  5. Optional: Setzen Sie Collection (optional) als Filter. Leer lassen = gilt für alle Collections (in der Regel empfohlen).
  6. Tragen Sie die Ziel-URL ein (z. B. https://example.com/intraonline/webhook).
  7. Wählen Sie die HTTP-Methode (POST, PUT oder PATCH).
  8. Optional: Hinterlegen Sie zusätzliche Header (z. B. ein Authorization-Token).
  9. Optional: Hinterlegen Sie ein Secret. Dann signiert intraOnline jede Zustellung per HMAC und sendet die Signatur im Header X-Signature.
  10. Optional: Definieren Sie ein Body-Template (siehe „Events & Payload“).
  11. Speichern Sie den Webhook.

Hinweise:

  • Das Secret wird nach dem Speichern nicht angezeigt. Falls Sie es rotieren möchten, hinterlegen Sie ein neues Secret.
  • Wenn Sie das Payload-Format auf raw setzen, benötigen Sie ein Body-Template. Ohne Template schlägt die Zustellung mit einem Konfigurationsfehler fehl.
  • Ihr Endpoint sollte keine Redirects (3xx) zurückgeben, sondern direkt mit 2xx antworten.

WebApp: Webhook testen​

Auf der Detailseite eines Webhooks finden Sie den Bereich „Webhook testen“.

  • Sie können optional Event-Typ, Document ID und ein JSON-Payload angeben.
  • Der Test stößt eine Test-Zustellung an. Das Ergebnis sehen Sie in der Zustellliste (Status, HTTP-Code, Fehlermeldung).

Tipp: Header-Konflikte vermeiden​

Bestimmte Header werden von intraOnline gesetzt und können nicht überschrieben werden (z. B. Content-Type, X-Event-Id, X-Event-Type, X-Signature). Legen Sie eigene Header deshalb immer zusätzlich an (z. B. Authorization).