Webhooks: CostGuard-Warnungen an Ihre Tools senden
Wie Sie ein Ziel registrieren, sein Signaturgeheimnis aufbewahren, jede Zustellung prüfen und ein Ziel ausschalten, und welche Ereignisse CostGuard sendet.
Wozu diese Seite dient
Webhooks sendet die Warnungen des Arbeitsbereichs an Systeme, die Sie betreiben, etwa einen Chatbot, ein Incident-Tool oder Ihren eigenen Dienst. Die Seite zeigt, welche Ziele welche Ereignisse erhalten und ob die letzten Zustellungen angekommen sind.
CostGuard signiert jede Zustellung und wiederholt eine fehlgeschlagene nach einem festen Zeitplan, bis zu fünf Versuche. Gesendet werden nur die unten aufgeführten Ereignisse; sonst verlässt nichts das System.
Bevor Sie beginnen
Sie brauchen:
- Den Tarif Pro oder Enterprise; andere Tarife sehen ein gekennzeichnetes Beispiel.
- Eine HTTPS-Adresse auf einem öffentlichen Host, die eine POST-Anfrage annimmt und die Signatur prüft, bevor sie der Anfrage vertraut.
Ein Ziel registrieren
Füllen Sie unter „Ziel registrieren“ aus:
- „Name“: ein kurzer, einfacher Name, den Sie in den Listen wiedererkennen.
- „Ziel-URL“: Muss eine HTTPS-Adresse auf einem öffentlichen Host sein. CostGuard prüft weder, ob die Adresse erreichbar ist, noch ob sie Ihnen gehört.
- „Zu sendende Ereignisse“: Budgetrisiko erkannt, Prognoserisiko erkannt und Kostensynchronisierung fehlgeschlagen, die drei Ereignisse, die CostGuard heute erzeugt.
Unter „Derzeit nicht erzeugt“ nennt die Seite die übrigen Ereigniskategorien, die nicht gewählt werden können: CostGuard benennt diese Ereigniskategorien, löst derzeit aber keine davon aus; sie können daher nicht ausgewählt werden. Für sie würde nie etwas gesendet.
„Ziel registrieren“ schaltet das Ziel sofort ein. Ein Arbeitsbereich kann bis zu zehn Ziele registrieren; der Bereich zählt, wie viele belegt sind.
Das Signaturgeheimnis
Wenn ein Ziel registriert wird, zeigt die Seite sein „Signaturschlüssel“ einmal. Kopieren Sie ihn jetzt. Er wird einmal angezeigt und kann nicht erneut angezeigt werden; geht er verloren, stellen Sie einen neuen aus, wodurch der alte ungültig wird.
Jede Zustellung trägt einen X-CostGuard-Signature-Header, eine mit dem Signaturschlüssel des Ziels erstellte HMAC-SHA256-Signatur, und einen X-CostGuard-Timestamp-Header. Ihr Empfänger prüft die Signatur, bevor er der Anfrage vertraut.
„Neuen Schlüssel ausstellen“ fragt zuerst nach: Das aktuelle Geheimnis wirkt sofort nicht mehr, und Ihr Empfänger lehnt Zustellungen ab, bis er das neue hat.
Registrierte Ziele
„Registrierte Ziele“ führt jedes Ziel mit seinen Ereignissen, „Zustand“, „Letzte Zustellung“ und „Registriert (UTC)“ auf. Seine Aktionen:
- „Ausschalten“ und „Einschalten“: Solange ein Ziel ausgeschaltet ist, wird keine neue Zustellung dafür erstellt; eine bereits wartende Zustellung wird gesendet, sobald es wieder eingeschaltet ist.
- „Neuen Schlüssel ausstellen“: siehe das Signaturgeheimnis oben.
- „Entfernen“: Es wird mit seinem Signaturschlüssel entfernt, und nichts wird mehr dorthin gesendet.
Ausschalten, ein neues Geheimnis ausstellen und Entfernen fragen jeweils zuerst nach; Einschalten geschieht sofort.
Letzte Zustellungen
Die neuesten Zustellungen dieses Arbeitsbereichs, bis zu hundert, die neueste zuerst. Die Zeiten sind in UTC. Jede Zustellung hat einen Status:
- „Zugestellt“: Ihr Endpunkt hat sie angenommen.
- „Wartend“: Sie wird versucht oder nach dem festen Plan erneut versucht.
- „Abgelehnt“: Ihr Endpunkt hat sie abgelehnt, oder die Adresse darf nicht aufgerufen werden; sie wird nicht erneut versucht.
- „Aufgegeben“: Es gab fünf Versuche, ohne dass Ihr Endpunkt sie rechtzeitig angenommen hat.
„Versuche“ zählt die Versuche, und „Detail“ sagt in einfachen Worten, was geschah, etwa „Ihr Endpunkt hat nicht rechtzeitig geantwortet“ oder „Ihr Endpunkt hat die Anfrage abgelehnt“. Eine Zustellung an ein inzwischen entferntes Ziel zeigt „Ein entferntes Ziel“.
Wie Webhooks funktionieren
Eine Zustellung, die Ihr Endpunkt nicht rechtzeitig angenommen hat, wird nach einer, fünf, fünfzehn und sechzig Minuten erneut versucht, insgesamt fünf Versuche; nach dem fünften erscheint sie als „Aufgegeben“. Eine Zustellung, die Ihr Endpunkt abgelehnt hat, oder eine Adresse, die CostGuard nicht aufrufen darf, wird nicht erneut versucht.
Die Ereignisse tragen dieselben Warnungen, die der Arbeitsbereich über „Warnregeln“ auslöst; ein Ereignis wird nur gesendet, wenn eine solche Warnung ausgelöst wird.
Webhooks sind getrennt von E-Mail- und In-App-Warnungen: „Benachrichtigungseinstellungen“ regelt diese, und „Zustellverlauf der Warnungen“ führt sie auf.
Was Sie statt der Zahlen sehen können
Während die Seite liest, stehen graue Balken an der Stelle der Panels. Danach kann die Seite stattdessen einen dieser Zustände zeigen:
- „Registrierte Ziele konnten nicht gelesen werden“: Das bedeutet nicht, dass der Arbeitsbereich keine hat. Versuchen Sie es erneut.
- Dieser Arbeitsbereich hat kein Ziel registriert.
- „Letzte Zustellungen konnten nicht gelesen werden“: Das bedeutet nicht, dass nichts zugestellt wurde. Laden Sie die Seite neu, um es erneut zu versuchen.
- CostGuard konnte nicht bestätigen, ob diese Änderung gespeichert wurde. Die Liste unten zeigt den aktuellen Stand des Arbeitsbereichs.
Wenn Ihr Tarif keine Webhooks enthält
In Free, Starter und Growth zeigt die Seite ein festes Beispiel unter der Kennzeichnung „Beispieldaten“ mit dem Satz „Ihr aktueller Tarif enthält diese Funktion nicht. Die hier gezeigten Zahlen sind ein Beispiel, nicht Ihre Daten.“
Das Beispiel zeigt erfundene Ziele und Zustellungen, ohne Schaltfläche, ohne Geheimnis und ohne eine Ihrer Adressen.
„Tarife vergleichen“ öffnet die Preisseite in einem neuen Tab. CostGuard entscheidet auf dem Server, was Ihr Tarif enthält; das Beispiel ist nur, wie die Seite es zeigt.
Was jeder Tarif enthält
Die Tabelle zeigt den ersten Tarif, der jeden Teil der Seite enthält. Jeder höhere Tarif enthält ihn ebenfalls.
| Funktion | Free | Starter | Growth | Pro | Enterprise |
|---|---|---|---|---|---|
| Ein gekennzeichnetes Beispiel der Seite | Enthalten | Enthalten | Enthalten | Enthalten | Enthalten |
| Ziele registrieren und Ereignisse senden | Nicht enthalten | Nicht enthalten | Nicht enthalten | Enthalten | Enthalten |
Pro und Enterprise enthalten Webhooks; Free, Starter und Growth zeigen das gekennzeichnete Beispiel. Der Tarif wird auf dem Server geprüft, und die Seite zeigt nie einen Preis.
Fehlerbehebung
Mein Empfänger lehnt die Signatur ab
Der Empfänger hat ein altes oder falsch eingegebenes Geheimnis. Stellen Sie ein neues aus, hinterlegen Sie es sofort im Empfänger und prüfen Sie, dass die Signatur über die Anfrage so berechnet wird, wie sie empfangen wurde.
Zustellungen zeigen „Aufgegeben“
Ihr Endpunkt hat bei keinem der fünf Versuche rechtzeitig angenommen: Er war nicht erreichbar, zu langsam oder lieferte einen Fehler. Beheben Sie das; neue Ereignisse werden zugestellt, sobald er antwortet.
Die Seite lehnt meine Adresse ab
CostGuard konnte diese Adresse nicht verwenden. Sie muss HTTPS sein, auf einem öffentlichen Host liegen und einen Standardport verwenden. Eine Adresse mit Benutzername oder Kennwort darin wird ebenfalls abgelehnt.
Ich kann kein weiteres Ziel registrieren
Der Arbeitsbereich hat zehn Ziele registriert, das Höchstmaß. Entfernen Sie zuerst eines, das Sie nicht mehr nutzen.