Créer des webhooks

En tant qu’administrateur d’une organisation, vous pouvez configurer des webhooks pour le déploiement ArcGIS Enterprise afin d’être notifié lorsque des événements spécifiques se produisent. Les sections ci-dessous expliquent comment configurer des webhooks d’organisation et de service.

Conditions préalables à la création de webhooks

Tenez compte des points suivants avant de créer des webhooks :

• Pour utiliser des webhooks d’organisation, l’organisation doit utiliser ArcGIS Enterprise version 10.7 ou ultérieure. Pour utiliser des webhooks de service, l’organisation doit utiliser ArcGIS Enterprise version 11.0 ou ultérieure.
• Pour créer et gérer des webhooks d’organisation, vous devez disposer du privilège Webhooks d’organisation ou du rôle d’administrateur par défaut.
• Pour créer et gérer des webhooks de service de géotraitement, vous devez disposer du privilège Géotraitement, du rôle d’administrateur par défaut ou du rôle d’éditeur.
• Pour créer et gérer des webhooks de service d’entités, vous devez disposer du privilège Couche d’entités, du rôle d’administrateur par défaut ou du rôle d’éditeur.
• Les récepteurs de webhook doivent être configurés de façon à communiquer via HTTPS. Quelques options sont prises en charge pour les récepteurs, tels que les récepteurs de service Web tiers (Microsoft Power Automate, Zapier et IFFT) et les services Web personnalisés. Pour accéder à des exemples de création de services Web personnalisés ou vous familiariser avec les récepteurs tiers, reportez-vous à la rubrique Référentiel de webhook.
• Vous pouvez configurer des webhooks pour un service d’entités hébergé uniquement si ce dernier inclut la fonctionnalité de mise à jour et bénéficie du suivi des modifications sans la synchronisation.
• Pour configurer des webhooks pour un service d’entités non hébergé, les données de géodatabase d’entreprise référencées par le service doivent respecter les exigences du suivi des modifications et suivre un des modèles suivants :
  • Il s’agit d’un service d’entités non versionné pour lequel l’archivage est activé et qui dispose d’ID globaux.
  • Il s’agit d’un service d’entités de branche versionnée sans la fonctionnalité de gestion des versions activée, dans lequel les mises à jour sont directement appliquées aux entités de la version par défaut.
  • Il s’agit d’un service d’entités de branche versionnée avec la fonctionnalité de gestion des versions activée. Lorsque la fonctionnalité de gestion des versions est activée, le service peut créer un webhook disposant du déclencheur d’événement FeaturesPosted, qui invoque le webhook dès que l’opération post est effectuée sur le service.

  Remarque :

  La prise en charge des services d’entités de branche versionnée a été ajoutée dans ArcGIS Enterprise 11.3.

• Vous pouvez configurer des webhooks pour un service de géotraitement uniquement si ce dernier est asynchrone.

Configurer les webhooks d’organisation

Les webhooks d’organisation vous permettent de vous abonner aux déclencheurs d’événement associés avec des éléments, des groupes et des utilisateurs du portail ArcGIS Enterprise.

Créer un webhook d’organisation

Pour créer un webhook d’organisation via le site Web du portail ArcGIS Enterprise, procédez comme suit :

1. Assurez-vous d’être connecté en tant qu’administrateur par défaut ou en tant que membre d’un rôle personnalisé disposant du privilège Webhooks d’organisation.
2. Accédez à Organization (Organisation) > Settings (Paramètres) > Webhooks.
3. Sous Organization webhooks (Webhooks d’organisation), cliquez sur Create webhook (Créer un webhook).
4. Dans la fenêtre Create webhook (Créer un webhook), effectuez les opérations suivantes :
   1. Spécifiez un nom unique pour le webhook dans la zone de texte Name (Nom).
   2. Sélectionnez un type de webhook dans le menu déroulant Type.
      • Si vous sélectionnez All (Tout), vous êtes abonné à tous les déclencheurs d’événement pris en charge. Vous recevez alors des notifications pour chaque événement lorsqu’il se produit.
      • Sélectionnez Items (Éléments), Users (Utilisateurs), Groups (Groupes) ou Roles (Rôles) pour définir manuellement les déclencheurs d’événements auxquels vous voulez vous abonner.
   3. Si vous sélectionnez un type de webhook différent de All (Tout), un menu déroulant supplémentaire relatif au type de webhook choisi s’affiche. Par exemple, si vous avez sélectionné Items (Éléments) comme type de webhook, le menu déroulant Items (Éléments) s’affiche, vous permettant de sélectionner un élément spécifique surveillé par le webhook.
   4. Sélectionnez des déclencheurs d’événements dans le menu déroulant Events (Événements). Par exemple, si vous voulez appeler le webhook lorsqu’un élément spécifique est publié, sélectionnez /items/<ID élément>/publish.
   5. Indiquez l’URL de charge utile du récepteur de webhook dans la zone de texte Webhook URL (URL du webhook). Voici un exemple d’URL de charge utile :
      https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow
      

   6. Vous pouvez éventuellement définir une valeur secrète pour le webhook dans la zone de texte Secret (Optional) (Secret [Facultatif]). La valeur secrète permet de générer une signature incluse dans les en-têtes de charge utile d’un webhook. Le récepteur webhook peut l’utiliser pour déterminer si le message est fiable.
5. Cliquez sur Create webhook (Créer un webhook).

Configurer les paramètres avancés des webhooks d’organisation

Les paramètres avancés appliqués aux webhooks de l’organisation vous permettent de personnaliser davantage les performances des webhooks, en spécifiant par exemple le nombre de tentatives de livraison, l’heure de notification et la durée entre les tentatives de livraison.

Pour définir les propriétés avancées à partir du site Web du portail ArcGIS Enterprise, procédez comme suit :

1. Connectez-vous à l’organisation en tant qu’administrateur par défaut ou en tant que membre d’un rôle personnalisé disposant du privilège Webhooks d’organisation.
2. Accédez à Organization (Organisation) > Settings (Paramètres) > Webhooks.
3. Sous Organization webhooks (Webhooks d’organisation), cliquez sur Advanced webhook settings (Paramètres de webhook avancés).
4. Dans la fenêtre Advanced webhook settings (Paramètres de webhook avancés), effectuez les opérations suivantes :
   1. Définissez une valeur pour Number of delivery attempts (Nombre de tentatives de livraison).

      Cette valeur indique le nombre de tentatives de livraison des charges utiles des webhooks. Par défaut, le portail ArcGIS Enterprise effectue 3 tentatives de livraison des charges utiles. Le nombre de tentatives doit être un entier compris entre 0 et 5.

   2. Définissez une valeur pour Notification timeout (Délai d’expiration des notifications).

      Cette valeur indique la durée, en secondes, pendant laquelle le portail ArcGIS Enterprise attend une réponse de la part d’un récepteur. Par défaut, le portail ArcGIS Enterprise attend pendant 10 secondes. La valeur de la durée d’attente du portail ArcGIS Enterprise doit être un entier compris entre 0 et 60.

   3. Définissez une valeur pour Notification elapsed time (Temps écoulé des notifications).

      Cette valeur indique la durée écoulée, en secondes, entre chaque tentative de livraison de charge utile. Par défaut, le portail ArcGIS Enterprise tente de livrer une autre charge utile au bout de 5 secondes en cas d’échec de la tentative précédente, jusqu’à ce que le nombre de tentatives spécifié dans Number of delivery attempts (Nombre de tentatives de livraison) soit atteint.

5. Une fois les paramètres ci-dessus configurés, cliquez sur Save (Enregistrer).

   Les propriétés mises à jour sont appliquées à tous les webhooks d’organisation configurés.

Configurer des webhooks de service

Les webhooks de service vous permettent de vous abonner aux déclencheurs des événements associés aux services d’entités de votre organisation ou lorsque les tâches d’un service de géotraitement sont terminées.

Créer un webhook de service

Pour créer un webhook pour un service de géotraitement ou un service d’entités, procédez comme suit :

1. Connectez-vous à votre organisation en tant qu’administrateur par défaut ou membre d’un rôle personnalisé doté des privilèges administratifs nécessaires pour créer et gérer des webhooks de service.

   Remarque :

   Les membres qui bénéficient du rôle Publication ne peuvent pas créer ou gérer des webhooks de service à partir du site du portail ArcGIS Enterprise et doivent effectuer ces processus à l’aide de l’API d’administration.

2. Accédez à Organization (Organisation) > Settings (Paramètres) > Webhooks.
3. Sous Service webhooks (Webhooks de service), cliquez sur Create webhook (Créer un webhook).
4. Dans la fenêtre Create webhook (Créer un webhook), effectuez les opérations suivantes :
   1. Spécifiez un nom unique pour le webhook dans la zone de texte Name (Nom).
   2. Sélectionnez un service dans le menu déroulant Service.

      Remarque :

      La sélection d’un service de géotraitement définit l’événement sur Service is finished (Service terminé). La sélection d’un service d’entités active le menu déroulant Events (Événements).

   3. Si vous sélectionnez un webhook de service d’entités, sélectionnez un déclencheur d’événements dans le menu déroulant Events (Événements). Par exemple, si vous voulez appeler le webhook lorsqu’une mise à jour inclut une nouvelle pièce jointe, sélectionnez AttachmentsCreated.
   4. Indiquez l’URL de charge utile du récepteur de webhook dans la zone de texte Webhook URL (URL du webhook). Voici un exemple d’URL de charge utile :
      https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow
      

   5. Vous pouvez éventuellement définir une valeur secrète pour le webhook dans la zone de texte Secret (Optional) (Secret [Facultatif]). La valeur secrète permet de générer une signature incluse dans les en-têtes de charge utile d’un webhook. Le récepteur webhook peut l’utiliser pour déterminer si le message est fiable.
5. Cliquez sur Create webhook (Créer un webhook).

Configurer les paramètres avancés des webhooks de service

Les paramètres avancés appliqués à vos webhooks de service vous permettent de personnaliser davantage les performances des webhooks, en spécifiant par exemple le nombre de tentatives de livraison, l’heure de notification et la durée entre les tentatives de livraison.

Pour définir les propriétés avancées à partir du site Web du portail ArcGIS Enterprise, procédez comme suit :

1. Connectez-vous à votre organisation en tant qu’administrateur par défaut ou membre d’un rôle personnalisé doté des privilèges administratifs nécessaires pour créer et gérer des webhooks de service.

   Remarque :

   Les membres qui bénéficient du rôle Publication ne peuvent pas créer ou gérer des webhooks de service à partir du site du portail ArcGIS Enterprise et doivent effectuer ces processus à l’aide de l’API d’administration.

2. Accédez à Organization (Organisation) > Settings (Paramètres) > Webhooks.
3. Sous Service webhooks (Webhooks de service), cliquez sur Advanced webhook settings (Paramètres de webhook avancés).
4. Dans la fenêtre Advanced webhook settings (Paramètres de webhook avancés), effectuez les opérations suivantes :
   1. Définissez une valeur pour Number of delivery attempts (Nombre de tentatives de livraison).

      Cette valeur indique le nombre de tentatives de livraison des charges utiles des webhooks. Par défaut, le système effectue 3 tentatives de livraison des charges utiles. Le nombre de tentatives doit être un entier compris entre 0 et 5.

   2. Définissez une valeur pour Notification timeout (Délai d’expiration des notifications).

      Cette valeur indique la durée, en secondes, pendant laquelle le système attend une réponse de la part d’un récepteur. Par défaut, le système patiente 10 secondes. La valeur doit être un entier compris entre 0 et 60 secondes.

   3. Définissez une valeur pour Notification elapsed time (Temps écoulé des notifications).

      Cette valeur indique la durée écoulée, en secondes, entre chaque tentative de livraison de charge utile. Par défaut, le système tente de livrer une autre charge utile au bout de 5 secondes en cas d’échec de la tentative précédente, jusqu’à ce que le nombre de tentatives spécifié dans Number of delivery attempts (Nombre de tentatives de livraison) soit atteint.

   4. Définissez une valeur pour Past number of days (Nombre de jours précédents).

      Cette valeur indique le nombre de jours au cours desquels un nombre spécifique d’échecs peuvent se produire avant la désactivation du webhook. Par défaut, le système accepte un nombre spécifique d’échecs (valeur du paramètre Maximum number of failures (Nombre maximal d’échecs)) dans un délai de 5 jours. La valeur doit être un entier compris entre 1 et 30.

   5. Définissez une valeur pour Maximum number of failures (Nombre maximal d’échecs).

      Cette valeur indique le nombre d’échecs pouvant se produire au cours d’un nombre spécifique de jours avant la désactivation du webhook. Par défaut, le système accepte 5 échecs sur un nombre de jours (valeur du paramètre Past number of days (Nombre de jours précédents)) avant la désactivation du webhook. La valeur doit être un entier compris entre 1 et 30.

5. Une fois les paramètres ci-dessus configurés, cliquez sur Save (Enregistrer).

   Les propriétés mises à jour sont appliquées à tous les webhooks de service configurés.