Webhooks
Wie man Webhooks in VergeOS für Push-basierte Nachrichten an externe Systeme konfiguriert, einschließlich Webhook-Erstellung, Einrichtung der Aufgaben-Payload und Konfiguration von Ereignistriggern.
Webhooks ermöglichen Push-basierte Nachrichten an externe Systeme, wenn bestimmte Ereignisse eintreten. Wenn ein Trigger-Ereignis eintritt, sendet ein Webhook eine HTTP-Anfrage (typischerweise eine POST-Anfrage) an eine vordefinierte URL. Dieser Push-Mechanismus ist sowohl für Benachrichtigungen als auch für die Workflow-Automatisierung effizienter als Polling, da das empfangende System nicht regelmäßig nach Aktualisierungen suchen muss.
Beispiele für die Verwendung von Webhooks
VergeOS-Webhooks ermöglichen eine hohe Konfigurierbarkeit für ereignisgesteuerte Kommunikation mit Drittanbietersystemen und bieten zahlreiche Möglichkeiten zur Optimierung. Die folgenden grundlegenden Beispiele zeigen mögliche Alarm- und Workflow-Automatisierung mithilfe von Webhooks:
Sende eine Slack-Benachrichtigung an einen Admin-Channel, wenn ein Synchronisierungsauftrag einen Fehler erzeugt
Sende an ein Buchhaltungssystem, wenn ein VergeOS-Tenant online geht, und löse eine automatische Belastung aus
Löse einen Zapier-Workflow aus, wenn eine bestimmte VM eingeschaltet wird, und initiiere anwendungsübergreifende Aktionen (z. B. Berichte, E-Mails, Benachrichtigungen usw.)
Konfigurationsschritte
Um einen Webhook in Betrieb zu nehmen, befolgen Sie diese Schritte:
Webhook erstellen: definiert die Ziel-URL, die Authentifizierungsmethode und alle benutzerdefinierten Header, die vom externen System benötigt werden
Aufgabe erstellen: definiert die bereitzustellende Nutzlast
Ereignis erstellen: legt ein Ereignis fest, das die Aufgabe auslöst
Modulares Design
Die VergeOS-Task-Engine ermöglicht eine flexible Orchestrierung von Webhooks, Aufgaben und Ereignissen. Sie können mehreren Webhooks mehrere Aufgaben oder Ereignisse zuweisen, und eine einzelne Aufgabe kann durch mehrere unterschiedliche Ereignisse ausgelöst werden. Diese Misch-und-Kombinier-Architektur unterstützt skalierbare, wiederverwendbare Workflows, die auf die Anforderungen Ihres Systems zugeschnitten sind.
Webhook erstellen
Navigieren Sie zu System > Aufgaben-Dashboard.
Klicken Sie auf Neuer Webhook im linken Menü.
Webhook konfigurieren:
Namen: Geben Sie dem Webhook einen aussagekräftigen Namen.
URL: Geben Sie den API-Endpunkt ein, der vom Zielsystem bereitgestellt wird, um HTTP-POST-Anfragen entgegenzunehmen.
In der Regel müssen Sie Ihrem VergeOS-System auf dem Zielsystem expliziten Zugriff auf diesen Endpunkt gewähren
Autorisierungstyp
Bearer-Token - Geben Sie nur die Bearer-Token-Zeichenfolge ein (fügen Sie das Wort "Bearer" nicht hinzu)
API-Schlüssel - Geben Sie nur die rohe API-Schlüssel-Zeichenfolge ein. (Fügen Sie kein Präfix oder Schlüsselwort hinzu)
Basic - Geben Sie Benutzername und Passwort in die vorgesehenen Eingabefelder ein.
Keine
Header
Standardmäßig ist ein Header enthalten, um eine Nutzlast anzugeben content-type: application/json. Dieser Header kann nach Bedarf entfernt oder bearbeitet werden, und zusätzliche Header können je nach Anforderung oder Unterstützung auf dem Zielsystem konfiguriert werden (z. B. Inhaltstyp, Ereignis-Routing, Ratenbegrenzung, Priorität usw.) - Um die Reihenfolge benutzerdefinierter Header zu ändern: Wählen Sie das Kontrollkästchen des gewünschten Headers aus und verwenden Sie die Pfeiltasten Nach oben/Nach unten - Verwenden Sie die Plus-Schaltfläche, um zusätzliche Header hinzuzufügen - Die Stift-Schaltfläche wechselt zwischen der Eingabe von Header-Schlüssel/Wert-Paaren und der manuellen Eingabe der vollständigen Header-Syntax
Unsichere Zertifikate zulassen: Diese Option ist für selbstsignierte Zertifikate in Test-/Entwicklungsumgebungen vorgesehen. Die Verwendung unsicherer Zertifikate für Produktionssysteme und -daten (insbesondere öffentliche URLs) ist riskant und nicht empfohlen.
Zeitüberschreitung: Definiert die maximale Anzahl an Sekunden, die auf eine Antwort vom Zielsystem gewartet werden soll (muss 3 oder größer sein)
Wiederholungen: Anzahl der Wiederholungsversuche, wenn vom Zielsystem keine Antwort oder ein Fehler zurückgegeben wird
Klicken Sie auf Absenden um den Webhook zu speichern.
Aufgabe erstellen
Navigieren Sie zu System > Aufgaben-Dashboard.
Klicken Sie auf Neue Aufgabe im linken Menü.
Aufgabe konfigurieren:
Namen: Geben Sie der Aufgabe einen aussagekräftigen Namen.
Beschreibung (optional): Zusätzliche Informationen können für die Aufgabe gespeichert werden, z. B. ihr Zweck, das erwartete Ergebnis usw.
Aufgabe nach Ausführung löschen: definieren Sie eine einmalige Aktivierung; das System löscht die Aufgabe automatisch, nachdem sie einmal ausgeführt wurde.
Objekttyp: Webhook
Objekt: Wählen Sie den im vorherigen Schritt erstellten Webhook aus.
Aktion: Senden
Nachricht: Definieren Sie die Nutzlast, die an das externe System gesendet werden soll. - Die Standard-Nutzlast enthält ein einfaches Schlüssel-Wert-Paar mit der Zeichenfolge "Webhook" als Wert; löschen oder ändern Sie sie nach Bedarf, um die gewünschte Nutzlast zu erstellen.
Variablen können innerhalb der Nachrichten-Nutzlast verwendet werden:
${DATE} - aktuelles Datum/Uhrzeit im vollständigen Zeichenfolgenformat, z. B. Do., 16. Okt. 2025 11:38:07 EDT
${TIMESTAMP} - aktuelles Datum/Uhrzeit als numerischer Wert (Epoch-Zeit), z. B. 1760629087
${RANDOM} - zufällig generierte Ganzzahl
${NAME} - Name des betreffenden VergeOS-Objekts
Klicken Sie auf Absenden um die Aufgabe zu speichern.
Ereignis erstellen
Navigieren Sie zu System > Aufgaben-Dashboard.
Klicken Sie auf Neues Ereignis im linken Menü.
Ereignis konfigurieren:
Typ: Wählen Sie den relevanten Bereich des VergeOS-Systems aus, in dem das Trigger-Ereignis stattfinden wird.
Ereignis: Die Ereignisliste ändert sich je nach oben ausgewähltem Typ. Wählen Sie das gewünschte Ereignis aus, das als Trigger dienen soll.
Wählen Sie eine bestimmte Objektinstanz oder ein Tag aus um das Ereignis auszulösen: (Einige ausgewählte Typen, wie Alarme gelten auf allgemeiner Ebene und bieten keine Optionen für Tags oder bestimmte Objekte.)
Wählen Sie eine bestimmte Instanz des Objekttyps aus der Dropdown-Liste aus (Zum Beispiel ist "Users" der ausgewählte Typ - wählen Sie einen bestimmten Benutzer aus der Benutzer Dropdown-Liste; "Virtual Machines" ist der ausgewählte Typ - wählen Sie eine bestimmte VM aus der Virtuelle Maschinen Dropdown-Liste.)
ODER
Aktivieren Sie den Tag verwenden Option und wählen Sie ein verfügbares Tag aus der Dropdown-Liste aus, um das Ereignis auf Objekte mit dem entsprechenden Tag zu basieren. (Zum Beispiel, wenn "Virtual Machines" der ausgewählte Typ ist und "production" in der Tag Dropdown-Liste ausgewählt ist, entspricht der Ereignisauslöser allen VMs, denen das Tag "production" zugewiesen ist.)
Aufgabe: Wählen Sie die im vorherigen Schritt erstellte Aufgabe aus.
Klicken Sie auf Absenden um das Ereignis zu speichern.
Versionskompatibilität: Diese Funktion ist in VergeOS 26.0 und höher verfügbar.
Zuletzt aktualisiert
War das hilfreich?