Webhooks konfigurieren

Die API nutzt Webhook-Benachrichtigungen, um Ihr System automatisch über Änderungen in Bezug auf Ihre Organisation zu informieren. Eine Ereignisressource wird an Ihren Webhook-Empfänger gesendet, wenn ein wichtiges Ereignis eintritt.

Die ricloud-py- CLI enthält Beispielimplementierungen eines Webhook-Endpunkts.

Erstellen einer Webhook-Konfiguration

Zum Erstellen einer Webhook-Konfiguration ist nur die URL erforderlich, an die die API ausgehende Ereignisse sendet.

ricloud-py implementiert einen Hilfsbefehl :

> ricloud webhook-config create --url "<webhook receiver URL>"

Der entsprechende cURL-Aufruf würde folgendermaßen aussehen:

curl https://ricloud-api.reincubate.com/configs/webhook \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "<webhook receiver URL>"
}'

Die Antwort auf diese Anforderung enthält das Webhook- secret , das wichtig ist, um die Implementierung Ihres Webhook-Empfängers in der Produktion sicherzustellen.

Überprüfen von Ereignissignaturen

Jede Webhook-Anfrage enthält einen Ricloud-Signature Header, mit dem überprüft werden soll, ob der Inhalt der Anfrage nicht geändert wurde. Der Header enthält auch einen Zeitstempel, der im Überprüfungsprozess verwendet wird, um Wiederholungsangriffen entgegenzuwirken.

ricloud-py beinhaltet eine Implementierung dieses Signaturprüfprozesses.