DocsIn App anmelden

Testen und aktivieren

Wie du einen Webhook mit einem Test prüfst, das Ergebnis liest, ihn danach aktivierst und wann vor dem Einschalten ein neuer Test nötig ist.

Ein Webhook lässt sich erst einschalten, wenn für seine aktuelle URL und HTTP-Konfiguration ein erfolgreicher Test gespeichert ist. Unter Organisation › Einstellungen › Entwickler › Webhooks sendest du einen Test, liest das Ergebnis und aktivierst den Webhook.

Kurz erklärt

Der Test sendet einen Beispiel-Datensatz, der als Test gekennzeichnet ist, und verändert nichts an deinen Daten. Als Erfolg zählt eine Antwort mit Status 200 bis 299. Ein erfolgreicher Test gilt nur, solange URL, Methode, Content-Type und HTTP-Header unverändert bleiben.

Typische Aufgaben:

Webhook testen

  1. Öffne den Webhook über Organisation › Einstellungen › Entwickler › Webhooks und Bearbeiten. Bei einem Webhook, der noch nicht angelegt ist, ist der Test gesperrt.
  2. Wähle im Bereich Webhook testen unter Event aus, was gesendet werden soll: ein eingerichtetes Event oder den Verbindungstest.
  3. Klicke auf Test senden. Während des Sendens steht auf dem Knopf Sende....
Der Bereich Webhook testen mit dem Auswahlfeld Event. Die Auswahl öffnet sich mit „Kunde anlegen“, „Kunde aktualisieren“ und „Verbindungstest“; gewählt wird „Verbindungstest“. Nach dem Klick auf „Test senden“ steht auf dem Knopf kurz „Sende...“, dann erscheint darunter der Bereich Request / Response: unter Request die Methode POST, die Ziel-URL, die Header mit ausgeblendeten Werten und der als Test gekennzeichnete Beispiel-Datensatz, unter Response das Kennzeichen „HTTP 200“, die Laufzeit in Millisekunden und die Antwort des Zielsystems.

Danach erscheint der Bereich Request / Response. Er zeigt, was i-Planner an die URL gesendet hat und was zurückkam. Unter Request stehen Methode, URL, Header und Body. Unter Response steht die Antwort mit dem Kennzeichen HTTP <Status> und der Laufzeit in Millisekunden. Sämtliche Header-Werte des Requests stehen dort als ***, auch die der Signatur.

Als Erfolg zählt eine Antwort mit Status 200 bis 299. Andernfalls steht unter Response in einem roten Kasten eine Meldung, etwa „Remote antwortete mit HTTP 500“ oder „Timeout nach 10000 ms“. Kam gar keine Antwort zurück, etwa nach einem Timeout, steht darunter „Es kam keine HTTP-Antwort zurück — Header und Body sind deshalb leer.“ Antwortet das Zielsystem erfolgreich, aber ohne Inhalt, steht unter Response nur „(keine Antwort vom Empfänger)“. Ist der Test-Aufruf selbst gescheitert, meldet i-Planner „Test fehlgeschlagen“. Das Ergebnis erscheint zusätzlich in der Übersicht, als Letzter Test erfolgreich oder Letzter Test Fehler.

Der Test verändert nichts an deinen Daten. Er sendet einen Beispiel-Datensatz, der als Test gekennzeichnet ist.

Webhook aktivieren

Aktivieren lässt sich ein Webhook nur, wenn für seine aktuelle URL und HTTP-Konfiguration ein erfolgreicher Test gespeichert ist.

  1. Öffne den Webhook über Organisation › Einstellungen › Entwickler › Webhooks und Bearbeiten.
  2. Sende im Bereich Webhook testen einen Test, bis das Ergebnis erfolgreich ist.
  3. Schalte unter Stammdaten den Schalter Aktiv ein. Alternativ wählst du in der Liste im Drei-Punkte-Menü des Webhooks Aktivieren.

Schaltest du Aktiv ohne gültigen Test ein, erscheint das Fenster Webhook zuerst testen mit dem Text „Für die aktuelle URL und HTTP-Konfiguration ist kein erfolgreicher Test gespeichert. Teste den Webhook im Bereich ‚Webhook testen‘; danach kannst du ihn aktivieren.“ Nach OK springt die Seite zum Knopf Test senden. Wählst du in der Liste Aktivieren, erscheint ein Fenster mit demselben Titel. Darin steht „Für die aktuelle URL und HTTP-Konfiguration ist kein erfolgreicher Test gespeichert. Öffne den Webhook über ‚Bearbeiten‘ und sende im Bereich ‚Webhook testen‘ einen erfolgreichen Test. Danach kannst du ihn aktivieren.“ Du schließt es mit Verstanden.

Der Test gilt nur, solange URL, Methode, Content-Type und HTTP-Header unverändert bleiben. Änderst du eines davon, musst du vor dem nächsten Aktivieren erneut erfolgreich testen. Hat jemand die HTTP-Konfiguration geändert, während du aktivierst, meldet i-Planner „Die Webhook-Konfiguration hat sich geändert. Bitte erneut erfolgreich testen.“

Unter dem Schalter Aktiv steht, woran du bist. Fehlt ein gültiger Test, steht dort „Vor dem Aktivieren musst du die aktuelle URL und HTTP-Konfiguration erfolgreich testen.“ Liegt ein gültiger Test vor, heißt es „Bereits erfolgreich getestet: Du kannst den Webhook ohne neuen Test aktivieren, solange die HTTP-Konfiguration unverändert ist.“ Bei einem aktiven Webhook steht dort „Du kannst den Webhook pausieren und bei unveränderter HTTP-Konfiguration ohne neuen Test wieder aktivieren.“ Fehlt einem aktiven Webhook der gespeicherte Test, steht dort „Kein erfolgreicher Test gespeichert: Nach dem Pausieren ist vor der Reaktivierung ein Test nötig.“

Weitere Themen

  • Webhook einrichten: URL, Methode, Content-Type und Header festlegen.
  • Fehlerbehebung: wenn sich Aktiv nicht einschalten lässt oder der Test eine Weiterleitung zurückbekommt.
  • Webhooks: einen aktiven Webhook pausieren, kopieren oder löschen.
Zurück
Webhook einrichten
Weiter
Fehlerbehebung