Webhook-Konfigurationen

Die Webhook-Konfigurationsressource wird von der API verwendet, um Ereignisse an Ihren Webhook-Empfänger zu senden.

Eine Organisation kann eine Standard-Webook-Konfiguration haben, die von allen Schlüsseln in dieser Organisation verwendet wird, die keine eigene Webook-Konfiguration angeben.

Attribute

Geheimnis

Wenn eine Webhook-Konfiguration erstellt wird, wird daneben ein Geheimnis generiert, mit dem von der API gesendete Ereignisse signiert werden. Es wird dringend empfohlen, dass Sie Ihren Webhook-Empfänger implementieren, um die Signatur eingehender Ereignisse mithilfe dieses Geheimnisses zu überprüfen. Weitere Informationen zur Überprüfung der Signatur finden Sie in den Konfigurationsdokumenten für Webhooks .

Zustände

• new wurde gerade erstellt oder kürzlich aktualisiert, aber noch nicht getestet.
• valid hat die Validierung bestanden und kann verwendet werden. Eine Organisation muss mindestens eine Webhook-Konfiguration in diesem Status haben, um verwendet werden zu können.
• invalid hat den Validierungstest nicht bestanden. Muss aktualisiert oder erneut getestet werden.
• deactivated wurde von der besitzenden Organisation deactivated .

Erstellen Sie POST /configs/webhook

Diese Aktion erstellt eine webhook_config.test Task, um die Endpunktdetails zu webhook_config.test . Wenn der Webhook-Empfänger noch nicht eingerichtet ist, schlägt dieser Test wahrscheinlich fehl und setzt die Konfiguration auf den invalid Status. Allerdings kann die Config immer erneut getestet werden , die unter Verwendung von Testaktion .

Parameter

CURL verwenden

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

Mit Ricloud-Py

import ricloud

webhook_config = ricloud.WebhookConfig.create(url='https://www.mywebhook.com/webhooks/')

GET /configs/webhook/{webhook_config ID}

CURL verwenden

curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID> \
  -H 'Authorization: Token <your key_token>'

Mit Ricloud-Py

import ricloud

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

Liste GET /configs/webhook

Webhook-Konfigurationen im deactivated Zustand sind standardmäßig ausgeblendet und können nur durch explizite Filterung aufgelistet werden.

Parameter

Aktualisieren Sie POST /configs/webhook/{webhook_config ID}

Diese Aktion erstellt im Hintergrund eine webhook_confg.test Task, um alle an der Konfiguration vorgenommenen Änderungen zu überprüfen.

Das Statusattribut kann nur in den deactivated state geändert werden, wenn Sie im Wesentlichen eine Konfiguration zurückziehen.

Parameter

CURL verwenden

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

Mit Ricloud-Py

import ricloud

webhook_config = ricloud.WebhookConfig.update_with_id(
  <webhook_config ID>,
  url='https://www.myupdatedwebhook.com/webhooks/'
)

# OR

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

webhook_config.update(url='https://www.myupdatedwebhook.com/webhooks/')

Testen Sie POST /configs/webhook/{webhook_config ID}/test

Diese Aktion erstellt eine webhook_config.test Task, die ein webhook_config.test mit der angegebenen Konfiguration sendet. Das Ergebnis des Tests wird das Update state Attribut der WeBook Konfiguration entsprechend.

CURL verwenden

curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID>/test \
  -H 'Authorization: Token <your key_token>'

Mit Ricloud-Py

import ricloud

test_task = ricloud.WebhookConfig.test_with_id(<webhook_config ID>)

# OR

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

test_task = webhook_config.test()