Vorschau · Entwicklungsstand 1.6.1

Webhook

Wofür ist das gedacht?

Startet die konfigurierte Aktion über POST /api/v1/webhooks/<hook_id>. Der Aufruf muss X-Webhook-Secret oder Authorization: Bearer mit dem gespeicherten Secret senden. HTTP 202 bestätigt eine angenommene Auslösung, nicht den erfolgreichen Abschluss des Jobs; diesen im Verlauf prüfen.

Einstellungen in der Oberfläche

Beispielwerte dienen zur Orientierung. Passe Pfade, Quellen und Geräte an deinen Arbeitsplatz an. Ein ausgeschaltetes Häkchen und die Zahl 0 sind ebenfalls gültige Beispielwerte.

Einstellung	Bedeutung und Bedienung	Beispielwert
hook_id	Stabile GUID des Webhook-Endpunkts /api/v1/webhooks/<hook_id>. Sie ist die Routing-ID und nicht der geheime Zugangsschlüssel.	Passenden Wert oder Ergebnis eines vorherigen Steps auswählen; Unterfelder siehe unten.
kind	Abgeleitete Triggerart zur Anzeige. Für die polymorphe Deserialisierung ist $type maßgeblich; die kanonische Vorlage zeigt die zusätzlich geschriebenen Kind/kind-Werte. Hotkey Start über Tastenkombination. Einmalig Einmaliger Start zu einem zukünftigen Zeitpunkt. Zeitplan Start zu einer Uhrzeit an ausgewählten Wochentagen. Intervall Start in einem positiven Wiederholungsintervall. Prozess gestartet Start, wenn ein passender Prozess neu erscheint. Prozess beendet Start, wenn ein passender Prozess beendet wird. Fensterereignis Start bei einem passenden Fensterereignis. Datei- oder Ordnerereignis Start bei einem passenden Datei-/Ordnerereignis. Windows-Systemereignis Start bei einem unterstützten Sitzungs-/Energie-/Systemereignis. Windows-Ereignis Start über eine unterstützte Funktion des Windows-Ereigniskatalogs. Webhook Start durch einen authentifizierten HTTP-POST-Aufruf.	Webhook
network_mode	Offline bindet lokal, Lan erlaubt lokale Netzwerkzugriffe, Online benötigt eine konfigurierte HTTPS-Basisadresse. Eine Online-Einstellung richtet keinen Tunnel automatisch ein. Offline (nur dieser PC) Webhook-Listener nur lokal verwenden. LAN Webhook-Listener für das lokale Netzwerk binden; Zugriff weiterhin mit Secret authentifizieren. Online Externen Zugriff über eine separat eingerichtete HTTPS-Adresse konfigurieren.	Offline (nur dieser PC)
online_base_url	Öffentliche HTTPS-Basisadresse ohne Query und Fragment für Online-Webhooks. Bereitstellung/Weiterleitung muss separat eingerichtet sein.	Beispieltext
port	Lokaler Listener-Port von 1024 bis 65535; Standard 17843. Er darf nicht bereits von einem anderen Dienst belegt sein.	17843
secret	Webhook-Zugangsschlüssel mit mindestens 24 Zeichen. Beim Aufruf X-Webhook-Secret oder Authorization: Bearer verwenden; kein echtes Secret in öffentlich geteilte Beispieldateien schreiben.	Beispieltext

Beispiel

Lege eine deaktivierte Automation an, wähle den beschriebenen Trigger beziehungsweise die Ziel-/Startregel und teste den Zieljob zuerst manuell. Die Dateianleitung zeigt die vollständige Hülle mit trigger, action und run_policy.

Vorbereitete Beispielabläufe ansehen

Fehler und Hinweise

Eine Triggerbeobachtung ist noch kein erfolgreicher Zielstart. Prüfe active, Ziel-ID, Pflichtparameter, aktives Zeitfenster, Cooldown und bereits laufendes Ziel. Für Webhooks zusätzlich Port, Netzwerkmodus und Authentifizierung prüfen; für Datei-Trigger muss der Ordner existieren. Diagnose und Startentscheidung stehen im Automationsverlauf.

Entwickler- und Agenten-Doku JSON, Feldnamen, Typen und Verträge

Dieser Bereich erklärt die Bearbeitung von Textdateien und die technischen Verträge. Zur Entwickler-Doku

Identifier: webhook

Felder und Zusammenhänge auf einen Blick

1
hook_idhook_id · Guid · Nicht angegeben
Stabile GUID des Webhook-Endpunkts /api/v1/webhooks/<hook_id>
2
kindkind · AutomationTriggerKind · Hotkey, OnceAt, Schedule, Interval, ProcessStarted, ProcessExited, WindowEvent, FileSystemEvent, SystemEvent, WindowsEvent, Webhook
Abgeleitete Triggerart zur Anzeige
3
network_modenetwork_mode · WebhookNetworkMode · Offline, Lan, Online
Offline bindet lokal, Lan erlaubt lokale Netzwerkzugriffe, Online benötigt eine konfigurierte HTTPS-Basisadresse
4
online_base_urlonline_base_url · String · Leerer Text
Öffentliche HTTPS-Basisadresse ohne Query und Fragment für Online-Webhooks
5
portport · Int32 · 17843
Lokaler Listener-Port von 1024 bis 65535; Standard 17843
6
secretsecret · String · Nicht angegeben
Webhook-Zugangsschlüssel mit mindestens 24 Zeichen

Schematische Übersicht: Beschriftungen und Werte aus der Referenz, keine nachgezeichnete Bedienoberfläche.

Feldtypen, Standards und Regeln

Wert	Typ	Standard laut Vertrag	Optionen und Regeln	Erklärung
hook_id `hook_id`	`Guid`	`Nicht angegeben`	Regeln siehe Erklärung	Stabile GUID des Webhook-Endpunkts /api/v1/webhooks/<hook_id>. Sie ist die Routing-ID und nicht der geheime Zugangsschlüssel.
kind `kind`	`AutomationTriggerKind`	`Webhook`	Regeln siehe Erklärung `["Hotkey", "OnceAt", "Schedule", "Interval", "ProcessStarted", "ProcessExited", "WindowEvent", "FileSystemEvent", "SystemEvent", "WindowsEvent", "Webhook"]`	Abgeleitete Triggerart zur Anzeige. Für die polymorphe Deserialisierung ist $type maßgeblich; die kanonische Vorlage zeigt die zusätzlich geschriebenen Kind/kind-Werte. `Hotkey` Start über Tastenkombination. `OnceAt` Einmaliger Start zu einem zukünftigen Zeitpunkt. `Schedule` Start zu einer Uhrzeit an ausgewählten Wochentagen. `Interval` Start in einem positiven Wiederholungsintervall. `ProcessStarted` Start, wenn ein passender Prozess neu erscheint. `ProcessExited` Start, wenn ein passender Prozess beendet wird. `WindowEvent` Start bei einem passenden Fensterereignis. `FileSystemEvent` Start bei einem passenden Datei-/Ordnerereignis. `SystemEvent` Start bei einem unterstützten Sitzungs-/Energie-/Systemereignis. `WindowsEvent` Start über eine unterstützte Funktion des Windows-Ereigniskatalogs. `Webhook` Start durch einen authentifizierten HTTP-POST-Aufruf.
network_mode `network_mode`	`WebhookNetworkMode`	`Offline`	Regeln siehe Erklärung `["Offline", "Lan", "Online"]`	Offline bindet lokal, Lan erlaubt lokale Netzwerkzugriffe, Online benötigt eine konfigurierte HTTPS-Basisadresse. Eine Online-Einstellung richtet keinen Tunnel automatisch ein. `Offline` Webhook-Listener nur lokal verwenden. `Lan` Webhook-Listener für das lokale Netzwerk binden; Zugriff weiterhin mit Secret authentifizieren. `Online` Externen Zugriff über eine separat eingerichtete HTTPS-Adresse konfigurieren.
online_base_url `online_base_url`	`String`	`Leerer Text`	Regeln siehe Erklärung	Öffentliche HTTPS-Basisadresse ohne Query und Fragment für Online-Webhooks. Bereitstellung/Weiterleitung muss separat eingerichtet sein.
port `port`	`Int32`	`17843`	Regeln siehe Erklärung	Lokaler Listener-Port von 1024 bis 65535; Standard 17843. Er darf nicht bereits von einem anderen Dienst belegt sein.
secret `secret`	`String`	`Nicht angegeben`	Regeln siehe Erklärung	Webhook-Zugangsschlüssel mit mindestens 24 Zeichen. Beim Aufruf X-Webhook-Secret oder Authorization: Bearer verwenden; kein echtes Secret in öffentlich geteilte Beispieldateien schreiben.

Diese Referenz für Textdateien und Agenten: Markdown · JSON-Vertrag

JSON-Vorlage für Textdateien und Agenten

Strukturelle Defaultvorlage direkt vom App-Serializer. Leere Pflichtwerte und Ziele vor Verwendung ergänzen; diese Vorlage ist kein vollständig validierter Ablauf. Bei neuen Jobs den aktuellen inputs/localValues-Vertrag verwenden.

Dateiformate und Regeln · JSON herunterladen

{
  "$type": "webhook",
  "Kind": "Webhook",
  "hook_id": "d4fa91c4-b683-2c23-b89c-7ab50f8b606c",
  "network_mode": "Offline",
  "port": 17843,
  "secret": "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD",
  "online_base_url": "",
  "kind": "Webhook"
}