Config Webhook

Mis à jour

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

Nom taper la description
id webhook config ID Resource identifier.
resource string, always webhook_config Resource type specifier.
organisation organisation ID The organisation the resource belongs to.
url string The url to target when sending events.
secret string The shared secret used to verify event signatures.
state string One of: new, valid, invalid, deactivated.
date_created datetime When the resource was created.

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

name type description
url required The URL of your webhook receiver.

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

name type description
state string Filter webhook configs by their state.
date_created datetime filter Filter by resource creation date.

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

name type description
url string Update the URL.
state string Only to new or deactivated.

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

Comment pouvons nous aider?

Notre équipe de support est là pour vous aider!

Nos bureaux sont ouverts du lundi au vendredi, de 9 h à 17 h GMT. L’heure est actuellement 11:06 Après-midi GMT.

Notre objectif est de répondre à tous les messages en un jour ouvrable.

Notre superbe équipe de support

Pouvons-nous améliorer cet article?

Nous aimons entendre les utilisateurs: pourquoi ne pas nous envoyer un email, laisser un commentaire ou tweet @reincubate?

© 2008 - 2024 Reincubate Ltd. Tous droits réservés. Enregistré en Angleterre et au Pays de Galles #5189175, VAT GB151788978. Reincubate® et Camo® sont des marques déposées. Politique de confidentialité & termes.