Forum aux questions sur les webhooks

Cette rubrique répertorie les questions et problèmes susceptibles d’être rencontrés lorsque l’on utilise des webhooks, ainsi que des solutions possibles.

• ArcGIS Enterprise est déployé dans un environnement déconnecté derrière le pare-feu de mon organisation. Puis-je tout de même configurer des webhooks ?

• En quoi consiste la mise à jour d’un élément, d’un utilisateur ou d’un groupe ?

• J’utilise l’authentification Windows intégrée sur mon portail ArcGIS Enterprise. Puis-je tout de même m’abonner aux utilisateurs qui se connectent au portail et s’en déconnectent (user/<username>/signIn) ?

• Que se passe-t-il si ma payload URL est indisponible ou ne fonctionne plus ? Existe-t-il un moyen de récupérer une payload qui n’a pas été livrée ?

• Mes webhooks de service seront-ils affectés si j’apporte des modifications à la configuration de mon site Enterprise ?

ArcGIS Enterprise est déployé dans un environnement déconnecté derrière le pare-feu de mon organisation. Puis-je tout de même configurer des webhooks ?

Oui. Pour configurer des webhooks, vous devez utiliser une payload URL que votre portail ArcGIS Enterprise peut atteindre. Pour ce faire, vous pouvez créer une application personnalisée et la déployer sur votre serveur interne.

En quoi consiste la mise à jour d’un élément, d’un utilisateur ou d’un groupe ?

Si vous vous êtes abonné aux mises à jour pour les éléments, utilisateurs et groupes de votre portail, votre webhook se déclenche dès que leurs propriétés sont mises à jour. Par exemple, si vous vous êtes abonné aux mises à jour d’un élément spécifique sur votre portail, votre webhook se déclenche si une mise à jour est apportée au titre, aux étiquettes ou à la miniature de cet élément. Pour déterminer facilement si une action constitue une mise à jour de votre portail, examinez le trafic réseau. Chaque fois qu’une action engendre l’appel de l’opération Update (Mise à jour), cette même action peut également déclencher un webhook qui écoutera les mises à jour.

J’utilise l’authentification Windows intégrée sur mon portail ArcGIS Enterprise. Puis-je tout de même m’abonner aux utilisateurs qui se connectent au portail et s’en déconnectent (user/<username>/signIn) ?

À partir de la version 10.9, vous pouvez utiliser l’événement déclencheur /signin afin de capturer les événements de connexion pour l’authentification au niveau du portail ou au niveau du Web et les identifiants de connexion d’entreprise.

Que se passe-t-il si ma payload URL est indisponible ou ne fonctionne plus ? Existe-t-il un moyen de récupérer une payload qui n’a pas été livrée ?

Lorsque vous configurez des webhooks d’organisation pour vos utilisateurs, vos groupes et vos éléments, vous avez la possibilité de configurer des paramètres avancés qui déterminent comment et quand le portail tente une autre livraison lorsqu’une payload n’est pas envoyée, ainsi qu’une politique de désactivation allant désactiver le webhook si les tentatives de livrer une payload continuent à échouer. Si le portail tente de livrer une payload à une payload URL ou à un récepteur de webhook qu’il ne parvient pas à atteindre ou qui ne répond pas, les paramètres avancés que vous avez définis déterminent le nombre de tentatives supplémentaires que le portail effectue pour livrer la payload. Si ces tentatives supplémentaires échouent également, cela compte comme un seul échec dans la politique de désactivation.

Pour voir les tentatives de livraison de la payload et déterminer si elles ont réussi ou non, vous pouvez également consulter l’état de notification du webhook.

Remarque :

À l’heure actuelle, les webhooks de service ne prennent pas en charge les politiques de suivi ou de désactivation de payload.

Mes webhooks de service seront-ils affectés si j’apporte des modifications à la configuration de mon site Enterprise ?

Puisqu’ils fonctionnent avec tous les composants majeurs d’un déploiement de base ArcGIS Enterprise (ArcGIS Data Store, ArcGIS Server et Portal for ArcGIS), les webhooks de service ont hérités d’une grande partie des modèles de résilience des composants car ils ont trait à la haute disponibilité et à la récupération d’urgence. Certaines modifications que vous apportez à votre déploiement Enterprise (par exemple, supprimer un ordinateur d’un site de serveur SIG) peuvent entraîner quelques minutes de temps d’arrêt avant que vos webhooks de service ne se remettent à fonctionner. Vous pouvez réduire la durée de temps d’arrêt survenant en revalidant vos serveurs fédérés après avoir apporté les modifications au site. Dans de rares cas, vous devrez peut-être redémarrer le service SIG lié afin qu’un webhook se remette à fonctionner. Si cette étape est nécessaire, un message de consignation de niveau WARNING (avertisssement) indiquant le besoin de redémarrer le service est enregistré dans les journaux du site.