Webhook senden

Was die Aktion Webhook senden an deinen Empfänger schickt, welche Einstellungen es gibt und wann der Schritt fehlschlägt.

Mit Webhook senden schickst du aus einer Automatisierung eine signierte HTTPS-POST-Anfrage an einen deiner Webhooks, zum Beispiel um ein externes System zu informieren. Das Gerät muss dafür nicht online sein.

Voraussetzungen

Ein unter Integrationen eingerichteter Webhook, der auf Aktiv geschaltet ist. Siehe Webhooks einrichten.

Auch diese Aktion sendet von der octoja-Plattform aus. Für eine Firewall oder IP-Freigabe vor deinem Webhook-Empfänger siehe IP-Adressen und Firewall-Freigaben.

Konfigurationsfelder

Feld	Typ	Pflicht	Standard	Beschreibung
Webhook	Auswahl	Ja	—	Der Webhook, an den die Anfrage geht. Zur Auswahl stehen deine konfigurierten Webhooks. Gibt es noch keinen, zeigt das Panel „Keine Webhooks konfiguriert. Lege zuerst unter Integrationen einen an.“ Die Liste erfordert die Berechtigung Integrationsverwaltung. Ohne sie erscheint diese Meldung auch dann, wenn Webhooks vorhanden sind.
Nachricht (optional)	mehrzeiliger Text	Nein	leer	Freier Text, der im Body als `message` mitgeschickt wird. Variablen `${{ … }}` fügst du über Variable einfügen ein

Anfrageformat

Die Anfrage hat dieselben Header wie jede andere Webhook-Zustellung von octoja, inklusive der eigenen Header deines Webhooks:

Header	Wert
`X-Octoja-Event`	`automation`
`X-Octoja-Delivery`	ID der Automatisierungsausführung. Alle Webhook senden-Schritte einer Ausführung senden denselben Wert
`X-Octoja-Timestamp`	Zeitpunkt der Signatur in Unix-Sekunden
`X-Octoja-Signature`	`sha256=<hex>`: HMAC-SHA256 über `{timestamp}.{body}`, signiert mit deinem Webhook-Secret
`User-Agent`	`octoja-Webhooks/1.0`
`Content-Type`	`application/json`

Anders als bei den übrigen Webhook-Ereignissen ist der Body ein flaches JSON-Objekt ohne data-Hülle:

{
  "event": "automation",
  "automation": "Onboard new device",
  "automationId": "00000000-0000-0000-0000-000000000001",
  "runId": "00000000-0000-0000-0000-000000000002",
  "assetId": "00000000-0000-0000-0000-000000000003",
  "message": "Onboarding finished on DEMO-PC-01"
}

Feld	Beschreibung
`event`	Immer `automation`
`automation`	Name der Automatisierung
`automationId`	ID der Automatisierung
`runId`	ID der Ausführung, derselbe Wert wie in `X-Octoja-Delivery`
`assetId`	ID des Geräts, auf dem die Ausführung läuft
`message`	Text aus Nachricht (optional) mit aufgelösten Variablen, sonst eine leere Zeichenkette

Plattformunterstützung

Die Aktion läuft in octoja und funktioniert auf jedem Betriebssystem gleich.

Ausgaben

Variable einfügen bietet für diese Aktion keine Ausgaben an. Die Antwort können spätere Schritte nicht verwenden.

Ergebnisverhalten

Fall	Ergebnis
Der Empfänger antwortet mit einem 2xx-Statuscode	Erfolgreich
Der Empfänger antwortet mit einem anderen Statuscode	Fehlgeschlagen, zum Beispiel mit `HTTP 500 Internal Server Error`
Nach 10 Sekunden ist keine Antwort da	Fehlgeschlagen mit `Timed out after 10s`
Netzwerkfehler, etwa ein nicht erreichbarer Host	Fehlgeschlagen mit der Fehlermeldung
Kein Webhook ausgewählt	Fehlgeschlagen: „Kein Webhook ausgewählt.“
Der Webhook wurde gelöscht	Fehlgeschlagen: „Der ausgewählte Webhook existiert nicht mehr.“
Der Webhook ist deaktiviert	Fehlgeschlagen: „Der ausgewählte Webhook ist deaktiviert.“

Der Schritt sendet genau eine Anfrage. Schlägt die Zustellung fehl, versucht octoja es nicht erneut. Den Versuch findest du im Tab Historie des Webhooks. Wenn Gerät offline hat auf diese Aktion keinen Einfluss.

Testlauf und Schritt testen senden die Anfrage wirklich an deinen Empfänger.

Siehe auch: Eine Automatisierung erstellen · Webhooks einrichten

War dies hilfreich?

Brauchen Sie noch Hilfe? Team fragen