Config Webhook

L'API utilise la ressource de configuration webhook pour envoyer des événements à votre récepteur webhook.

Une organisation peut avoir une configuration Webook par défaut qui est utilisée par toutes les clés de cette organisation qui ne spécifient pas leur propre configuration Webhook.

Les attributs

Secret

Lors de la création d'une configuration webhook, un secret sera généré à côté de celle-ci et sera utilisé pour signer les événements envoyés par l'API. Il est vivement recommandé de mettre en œuvre votre récepteur webhook pour vérifier la signature des événements entrants à l'aide de ce secret. Pour plus de détails sur la procédure de vérification de la signature, voir la documentation de configuration de webhook .

États

• new vient d'être créé ou a été mis à jour récemment mais n'a pas encore été testé.
• valid a passé la validation et est prêt à être utilisé. Une organisation doit avoir au moins une configuration Webhook dans cet état pour pouvoir être utilisée.
• invalid a échoué le test de validation. Doit être mis à jour ou retesté.
• deactivated a été désactivé par l’organisation propriétaire.

Créer un POST /configs/webhook

Cette action créera une tâche webhook_config.test afin de valider les détails du noeud final. Si le récepteur webhook n'est pas encore configuré, ce test échouera probablement et définira la configuration sur l'état invalid . Cependant, la configuration peut toujours être testée à nouveau à l'aide de l' action de test .

Paramètres

Utiliser cURL

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/"
}'

Utiliser ricloud-py

import ricloud

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

Récupérer GET /configs/webhook/{webhook_config ID}

Utiliser cURL

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

Utiliser ricloud-py

import ricloud

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

Liste GET /configs/webhook

Les configurations Webhook à l'état deactivated sont masquées par défaut et ne peuvent être répertoriées que par filtrage explicite.

Paramètres

Mise à jour du POST /configs/webhook/{webhook_config ID}

Cette action créera une tâche webhook_confg.test en arrière-plan pour valider les modifications apportées à la configuration.

L'attribut d' state ne peut être changé en deactivated dans le cas où vous retirez une configuration.

Paramètres

Utiliser cURL

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/",
}'

Utiliser 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/')

Tester le POST /configs/webhook/{webhook_config ID}/test

Cette action crée une tâche webhook_config.test qui envoie un événement test à l'aide de la configuration spécifiée. Le résultat du test mettra à jour l'attribut d' state de la configuration webook en conséquence.

Utiliser cURL

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

Utiliser 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()