Les webhooks permettent aux applications externes de recevoir des notifications en temps réel lorsque certains événements se produisent sur la plate-forme.
Pour utiliser des webhooks, vous devez les activer et générer des jetons. En utilisant deux secrets distincts pour une seule URL de webhook, vous ajoutez une couche de sécurité supplémentaire. Si un secret est compromis ou doit être modifié pour quelque raison que ce soit, vous pouvez le mettre à jour et le modifier sans interrompre le service de webhook ni compromettre la sécurité des données.
Activer les webhooks
Pour activer les webhooks, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Developer Settings (Paramètres > Paramètres pour les développeurs). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu.
Accédez au volet Webhooks, puis cliquez sur le bouton Webhooks pour l'activer.
Dans le champ URL, saisissez une URL de webhook. Cette URL est le point de terminaison qui reçoit les notifications en temps réel. Assurez-vous que ce webhook peut recevoir des requêtes HTTP.
Cliquez sur Generate (Générer). Cela génère le secret principal, qui est le jeton de sécurité principal utilisé pour authentifier et valider les charges utiles de webhook entrantes. Il s'agit du principal moyen de sécuriser la communication du webhook.
Copiez et enregistrez le jeton dans un endroit sûr.
Générez un secret secondaire. Le secret secondaire sert de jeton de sécurité de sauvegarde ou de basculement. Il est fourni comme mesure de sécurité supplémentaire pour améliorer la fiabilité et la disponibilité des notifications de webhook. Si, pour une raison quelconque, le secret principal est compromis ou si son utilisation pose problème, le secret secondaire peut prendre le relais et continuer à assurer la communication.
Copiez et enregistrez le jeton dans un endroit sûr.
Cliquez sur Save (Enregistrer).
Appliquer une rotation des secrets
Par mesure de sécurité, appliquez régulièrement une rotation des secrets de webhook. Ce processus consiste à générer de nouvelles clés secrètes pour les webhooks principaux et secondaires, et à les mettre à jour dans votre application pour continuer à recevoir des notifications de manière transparente.
Une fois la configuration initiale des webhooks effectuée, vous ne pouvez pas générer directement de nouveau secret principal. Toutefois, vous pouvez générer un nouveau secret secondaire et modifier les secrets.
Pour modifier les secrets, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Developer Settings (Paramètres > Paramètres pour les développeurs). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu.
Cliquez sur Rotate Secrets (Modifier les secrets).
Cliquez sur Save (Enregistrer).
Générer de nouveaux secrets
Pour modifier les secrets afin de disposer de deux nouvelles clés secrètes, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Developer Settings (Paramètres > Paramètres pour les développeurs). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu.
Cliquez sur Generate (Générer) pour générer un nouveau secret secondaire.
Cliquez sur Rotate Secrets (Modifier les secrets) pour faire du nouveau secret secondaire le secret principal.
Cliquez sur Generate (Générer) pour générer un deuxième secret secondaire qui remplacera l'ancien secret principal.
Cliquez sur Save (Enregistrer).