Hinzufügen von Webhooks¶
Webhooks werden global definiert. So können Sie einen bestimmten Endpunkt für mehrere Trigger oder Automatisierungen verwenden.
Warnung
Die Standard Zammad-Webhook-Payloads sind individuell
Beachten Sie, dass der externe Dienst in der Lage sein muss, den Standard-Webhook-Payload zu verstehen, den Zammad sendet. Einfach den Standard-Payload an einen Webhook-Endpunkt zu senden, führt möglicherweise nicht zum gewünschten Ergebnis!
Siehe Custom Payload für die Anpassung der Webhook-Payloads.
Um einen neuen regulären Webhook hinzuzufügen, verwenden Sie den grünen Button Neuer Webhook.
Für einen vordefinierten Webhook klicken Sie auf den Button mit dem Pfeil auf der rechten Seite und wählen Sie Vordefinierter Webhook aus dem Dropdown-Menü.
Wählen Sie dann den gewünschten vordefinierten Webhook aus und klicken Sie auf Weiter.
Warnung
⚠️ Hinzufügen eines neuen Webhooks reicht nicht aus
Sie müssen zusätzlich einen Trigger oder eine Automatisierung hinzufügen, die den Webhook auslöst!
Sie können die folgenden Informationen für Webhooks konfigurieren:
- Name (Pflichtfeld)
Dieser Name wird bei der Auswahl von Triggern und Automatisierungen angezeigt.
- Endpunkt (Pflichtfeld)
Webhook-Endpunkt, an den Zammad seinen Payload sendet.
Zammad ignoriert basic authentication Parameter. Siehe unten, wie man Benutzername und Passwort über separate Felder konfiguriert.
- HMAC SHA1 Signatur-Token
Wenn diese Option gesetzt ist, enthalten alle gesendeten Webhooks einen x-hub-signature-Header, der es der Gegenstelle ermöglicht, die Anfrage zu überprüfen.
Bemerkung
🔐 Sicherheitshinweis
Dies verschlüsselt die Nutzdaten nicht. Verwenden Sie HTTPS-Verbindungen, um die Kommunikation abzusichern. Sie enthält eine HMAC-Signatur des Bodys der Webhook-Anfrage
- SSL-Verifizierung
Standard is
ja
- wenn Sie unsichere selbstsignierte Zertifikate verwenden, setzen Sie diese Option aufnein
.Gefahr
Bitte beachten Sie, dass das Deaktivieren der SSL-Verifizierung ein Sicherheitsrisiko darstellt. Es sollte nur vorübergehend oder zu Testzwecken verwendet werden. Wenn diese Option deaktiviert ist, findet keine Überprüfung des Zertifikats statt, was bedeutet, dass jedes vorgelegte Zertifikat akzeptiert wird.
- HTTP Basic Authentication Username
Legen Sie dies fest, wenn der Endpunkt HTTP basic authentication Zugangsdaten erfordert.
- HTTP Basic Authentication Password
Legen Sie dies fest, wenn der Endpunkt HTTP basic authentication Zugangsdaten erfordert.
- Vordefinierter Webhook
Dieses Feld ist nur für vordefinierte Webhooks verfügbar!
Dieses Feld ist in der Benutzeroberfläche immer deaktiviert und dient nur als Verweis auf einen vordefinierten Webhook. Es ist nicht möglich, dies für bestehende Webhooks zu ändern.
Je nach dem vordefinierten Webhook-Typ können darunter weitere Felder angezeigt werden. Sie können für zusätzliche Anpassungen des Webhook-Verhaltens verwendet werden.
- Custom Payload
Standardmäßig ist diese Option ausgeschaltet - der Webhook sendet immer Standard-JSON-Nutzlast an den Endpunkt.
Nach dem aktivieren wird unten ein Code-Editor angezeigt, in dem Sie benutzerdefinierte Payloads für Ihren Webhook im JSON-Format konfigurieren können. Um unterstützte Variablen einzufügen, verwenden Sie
::
oder#{
für die Autovervollständigung.Benutzerdefinierte Payloads müssen eine gültige JSON-Syntax haben! Der Code-Editor wird Sie darauf hinweisen, wenn es ein Problem mit dem Code gibt. Außerdem ist es nicht möglich, eine ungültige JSON-Struktur zu speichern.
Hinweis
Vordefinierte Webhooks bieten immer einen vordefinierten Payload, der für den zugehörigen Dienst spezifisch ist.
- Notiz
Bei Bedarf können Sie weitere Informationen für andere Zammad-Administratoren hinterlegen, damit der betreffende Webhook besser verstanden wird.
- Aktiv
Bei der Einstellung
nicht aktiv
kann der Webhook nicht mehr in Triggern oder Automatisierungen ausgewählt werden.Inaktive Webhooks, die in Triggern oder Automatisierungen verwendet werden, werden nicht ausgeführt. Wenn Trigger oder Automatisierungen auch andere Aktionen konfiguriert haben, werden diese trotzdem ausgeführt.