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 même URL de webhook, vous ajoutez une couche de sécurité supplémentaire. Si un secret est compromis ou doit être renouvelé pour une raison quelconque, vous pouvez mettre à jour et renouveler les secrets 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 Paramètres ne s'affiche pas, cliquez sur Menu.
Accédez au volet Webhooks, puis cliquez sur le bouton Webhooks pour l'activer.
Pour 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 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 code secret secondaire. Le code secret secondaire sert de jeton de sécurité de sauvegarde ou de basculement. Il s'agit d'une mesure de sécurité supplémentaire visant à améliorer la fiabilité et la disponibilité des notifications de webhook. Si, pour une raison quelconque, le code secret principal est compromis ou si son utilisation pose problème, le code secret secondaire peut prendre le relais et continuer à assurer la communication.
Copiez et enregistrez le jeton dans un endroit sûr.
Cliquez sur Enregistrer.
Appliquer une rotation des secrets
Pour des raisons de sécurité, alternez régulièrement les secrets Webhook. Ce processus consiste à générer de nouvelles clés secrètes pour les Webhooks principal et secondaire, puis à les mettre à jour dans votre application pour continuer à recevoir des notifications de manière fluide.
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 faire une rotation des secrets pour les modifier.
Pour faire pivoter 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 Paramètres ne s'affiche pas, cliquez sur Menu.
Cliquez sur Appliquer une rotation des secrets.
Cliquez sur Enregistrer.
Générer de nouveaux secrets
Pour effectuer une rotation des secrets afin d'obtenir 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 Paramètres ne s'affiche pas, cliquez sur Menu.
Cliquez sur Générer pour générer un nouveau code secret secondaire.
Cliquez sur Faire pivoter les secrets pour définir le nouveau secret secondaire comme secret principal.
Cliquez sur Générer pour générer un deuxième secret secondaire qui remplacera l'ancien secret principal.
Cliquez sur Enregistrer.