Beskos

Referenz

Kanal-Webhooks

Nachrichten aus einem externen Dienst in einen Chat-Kanal senden.

Aktualisiert:

Diese Übersetzung dient der Bequemlichkeit. Im Falle von Abweichungen ist die englische Fassung maßgeblich.

Inhaltsverzeichnis

Ein Webhook ist eine URL, die eine HTTP-POST-Anfrage in eine Nachricht in genau einem Kanal umwandelt. Er dient dazu, Warnmeldungen, Build-Ergebnisse und Monitoring-Ausgaben in Chat zuzustellen.

Einen Webhook anlegen

Den Kanal öffnen → Einstellungen → Webhooks → Hinzufügen. Der vergebene Name wird als Autor jeder darüber gesendeten Nachricht angezeigt.

Beim Anlegen wird eine URL mit einem Token zurückgegeben. Das Token stellt die Autorisierung für den Kanal dar und ist wie eine Anmeldeinformation zu behandeln. Ein kompromittiertes Token lässt sich löschen.

Eine Nachricht senden

Ein JSON-Body mit einem Feld text.

curl -X POST https://app.beskos.com/api/public/chat/hook/<token> \
  -H 'Content-Type: application/json' \
  -d '{"text": "Deploy finished: build 1284 is live"}'

Ratenbegrenzung

Der Endpunkt ist je Quelladresse ratenbegrenzt, da er ohne Authentifizierung erreichbar ist. Übliche Alarmierungsvolumen sind davon nicht betroffen.