Gérer les webhooks

En tant qu’administrateur, vous pouvez mettre à jour et gérer les webhooks en mettant à jour leur configuration (par exemple, en mettant à jour les déclencheurs d’événement auxquels le webhook est abonné), ainsi qu’en désactivant et en supprimant des webhooks précédemment configurés.

Mettre à jour des webhooks

Vous pouvez mettre à jour les paramètres configurés pour les webhooks après leur création. Les sections ci-après expliquent comment mettre à jour les propriétés des webhooks d’organisation et de service.

Mettre à jour des webhooks d’organisation

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

1. Vérifiez que vous êtes connecté en tant qu’administrateur ou membre d’un rôle personnalisé doté des privilèges administratifs nécessaires pour créer et gérer les webhooks d’organisation.
2. Accédez à Organization (Organisation) > Settings (Paramètres) > Webhooks.
3. Sous Organization webhooks (Webhooks d’organisation), recherchez le webhook à mettre à jour.
4. Cliquez sur le bouton Options, puis sur Edit (Mettre à jour).
5. Dans la fenêtre Edit webhook (Mettre à jour un webhook), modifiez les éléments suivants :
   1. Pour mettre à jour le nom du webhook, indiquez un nom unique dans la zone de texte Name (Nom).
   2. Pour mettre à jour le type de webhook, cliquez sur le menu déroulant Type et sélectionnez un nouveau type de webhook.
      • 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énement 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. Pour mettre à jour les déclencheurs d’événement, cliquez sur le menu déroulant Events (Événements) et sélectionnez un nouvel événement déclencheur. Par exemple, si vous voulez appeler le webhook lorsqu’un élément spécifique est publié, sélectionnez /items/<ID élément>/publish.
   5. Si vous souhaitez mettre jour l’URL de charge utile, sélectionnez Webhook URL (URL du webhook) et indiquez l’URL de charge utile du récepteur du webhook.
   6. Si vous souhaitez mettre à jour le notebook, sélectionnez Notebook et choisissez le notebook qui s’exécutera au déclenchement du webhook.
   7. Vous pouvez ajouter une chaîne alphanumérique qui joue le rôle de secret pour le webhook ou mettre à jour un secret préexistant, 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 de webhook. Le récepteur de webhook peut l’utiliser pour déterminer si le message est fiable.
6. Cliquez sur Update webhook (Mettre à jour le webhook) pour appliquer les modifications.

Mettre à jour des webhooks de service

Pour mettre à jour les propriétés d’un webhook de service, procédez comme suit :

1. Vérifiez que vous êtes connecté 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 les 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), recherchez le webhook à mettre à jour.
4. Cliquez sur le bouton Options, puis sur Edit (Mettre à jour).
5. Dans la fenêtre Edit webhook (Mettre à jour un webhook), modifiez les éléments suivants :
   1. Pour mettre à jour le nom du webhook, indiquez un nom unique dans la zone de texte Name (Nom).
   2. Pour mettre à jour le service auquel le webhook est associé, cliquez sur le menu déroulant Service et sélectionnez un nouveau 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 les nouveaux déclencheurs d’événements dans le menu déroulant Events (Événements). Par exemple, si vous voulez appeler le webhook lorsqu’une pièce jointe à une entité est mise à jour, sélectionnez AttachmentsUpdated.
   4. Si vous souhaitez mettre jour l’URL de charge utile, sélectionnez Webhook URL (URL du webhook) et indiquez l’URL de charge utile du récepteur du webhook.
   5. Vous pouvez ajouter une chaîne alphanumérique qui joue le rôle de secret pour le webhook ou mettre à jour un secret préexistant, 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 de webhook. Le récepteur de webhook peut l’utiliser pour déterminer si le message est fiable.
6. Cliquez sur Update webhook (Mettre à jour le webhook) pour appliquer les modifications.

Désactiver des webhooks

Vous pouvez désactiver les webhooks manuellement ou une fois que la politique de désactivation est satisfaite. Lorsqu’un webhook est désactivé, il est mis en pause et ne peut pas livrer de charges utiles lorsqu’elles sont déclenchées. Les sections ci-après expliquent comment désactiver des webhooks d’organisation et de service.

Désactiver des webhooks d’organisation

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

1. Vérifiez que vous êtes connecté en tant qu’administrateur ou membre d’un rôle personnalisé doté des privilèges administratifs nécessaires pour créer et gérer les webhooks d’organisation.
2. Accédez à Organization (Organisation) > Settings (Paramètres) > Webhooks.
3. Sous Organization webhooks (Webhooks d’organisation), recherchez le webhook d’organisation à désactiver et cliquez sur Active (Actif).
4. Cliquez sur Confirm (Confirmer) pour mettre en pause le webhook.

Désactiver des webhooks de service

Pour désactiver un webhook de service, procédez comme suit :

1. Vérifiez que vous êtes connecté 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 les 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), recherchez le webhook de service à désactiver et cliquez sur Active (Actif).
4. Cliquez sur Confirm (Confirmer) pour mettre en pause le webhook.

Activer des webhooks

Lorsqu’un webhook est désactivé, il ne peut pas livrer de charges utiles. Une fois réactivé, le webhook redémarre et peut à nouveau livrer des charges utiles lorsqu’il est appelé. Les sections ci-après expliquent comment activer des webhooks d’organisation et de service précédemment désactivés.

Activer des webhooks d’organisation

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

1. Vérifiez que vous êtes connecté en tant qu’administrateur ou membre d’un rôle personnalisé doté des privilèges administratifs nécessaires pour créer et gérer les webhooks d’organisation.
2. Accédez à Organization (Organisation) > Settings (Paramètres) > Webhooks.
3. Sous Organization webhooks (Webhooks d’organisation), recherchez le webhook d’organisation à activer et cliquez sur Inactive (Inactif).
4. Cliquez sur Confirm (Confirmer) pour redémarrer le webhook.

Activer des webhooks de service

Pour activer un webhook de service, procédez comme suit :

1. Vérifiez que vous êtes connecté 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 les 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), recherchez le webhook de service à activer et cliquez sur Inactive (Inactif).
4. Cliquez sur Confirm (Confirmer) pour redémarrer le webhook.

Supprimer des webhooks

Si un webhook précédemment créé devient inutile, vous pouvez le retirer de manière définitive de l’organisation en le supprimant. Les sections ci-après expliquent comment supprimer des webhooks d’organisation et de service.

Supprimer des webhooks d’organisation

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

1. Vérifiez que vous êtes connecté en tant qu’administrateur ou membre d’un rôle personnalisé doté des privilèges administratifs nécessaires pour créer et gérer les webhooks d’organisation.
2. Accédez à Organization (Organisation) > Settings (Paramètres) > Webhooks.
3. Sous Organization webhooks (Webhooks d’organisation), recherchez le webhook d’organisation à supprimer.
4. Cliquez sur le bouton Options, puis sur Delete (Supprimer).
5. Dans la fenêtre Delete (Supprimer), cliquez sur le bouton Confirm (Confirmer) pour supprimer définitivement le webhook.

Supprimer des webhooks de service

Pour supprimer un webhook de service, procédez comme suit :

1. Vérifiez que vous êtes connecté 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 les 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), recherchez le webhook de service à supprimer.
4. Cliquez sur le bouton Options, puis sur Delete (Supprimer).
5. Dans la fenêtre Delete (Supprimer), cliquez sur le bouton Confirm (Confirmer) pour supprimer définitivement le webhook.