Creare webhook

Un amministratore può configurare webhook per l'installazione di ArcGIS Enterprise per ricevere notifiche quando si verificano eventi specifici. In questa sezione viene illustrato come configurare i webhook dell'organizzazione e del servizio.

Prerequisiti per la creazione di webhook

Prima di creare webhook, verifica i seguenti prerequisiti:

• Per usare i webhook dell'organizzazione, l'organizzazione deve usare ArcGIS Enterprise 10.7 o versione successiva. Per usare i webhook di servizio, l'organizzazione deve usare ArcGIS Enterprise 11.0 o versione successiva.
• Per creare e gestire webhook dell'organizzazione, è necessario disporre del privilegio per i webhook dell'organizzazione o del ruolo di amministratore predefinito.
• Per creare e gestire i webhook dei servizi di geoprocessing, è necessario disporre del privilegio di geoprocessing o del ruolo di amministratore predefinito.

  Nota:

  Gli utenti con privilegio di geoprocessing dovranno disporre anche del privilegio di pubblicazione dei layer basati su server aggiunto al proprio ruolo personalizzato.

• Per creare e gestire i webhook dei feature service, è necessario disporre del privilegio di feature layer o del ruolo di amministratore predefinito.
• I ricevitori di webhook devono essere configurati per comunicare su HTTP. Esistono alcune opzioni sopportate per i destinatari, ad esempio ricevitori di web service di terze parti (Microsoft Power Automate, Zapier e IFFT), web service personalizzati, ArcGIS Notebook Server e ArcGIS Workflow Manager. Per esempi che illustrano come creare web service personalizzati o iniziare a usare i ricevitori di terze parti, consulta Repository di webhook. Per ulteriori informazioni sulla creazione di webhook Notebook Server eWorkflow Manager, consulta Flussi di lavoro automatici con ArcGIS Notebooks e Creare lavori con webhook rispettivamente.
• Per configurare webhook per un feature service ospitato, il servizio deve includere la funzionalità Modifica e il monitoraggio traccia delle modifiche deve essere abilitato senza sincronizzazione.
• Per configurare webhook per un feature service non ospitato, i dati dell'enterprise geodatabase a cui il servizio fa riferimento devono soddisfare i requisiti per il rilevamento delle modifiche e seguire uno dei seguenti modelli:
  • Essere un feature service senza versione con archiviazione abilitata e ID globali.
  • Essere un feature service con versione a ramo senza funzionalità di Gestione della versione, in cui le modifiche vengono applicate direttamente alle feature della versione predefinita.
  • Essere un feature service con versione a ramo con funzionalità di Gestione della versione abilitata. Quando la funzionalità di Gestione della versione è abilitata, il servizio può creare un webhook che dispone di trigger evento FeaturesPosted, il quale invoca il webhook ogni volta che l'operazione post viene eseguita nel servizio.

  Nota:

  Il supporto per i feature service con versione a ramo è stato aggiunto in ArcGIS Enterprise 11.3.

• Per configurare webhook per il servizio di geoprocessing, il servizio deve essere asincrono.

Configurare i webhook dell'organizzazione

I webhook dell'organizzazione consentono di abbonarsi a trigger per eventi associati a elementi, gruppi e utenti del portale ArcGIS Enterprise.

Creare un webhook dell'organizzazione

Per creare un webhook dell'organizzazione tramite il sito Web del portale ArcGIS Enterprise, attenersi alla seguente procedura:

1. Verificare di aver effettuato l'accesso come amministratore predefinito o come ruolo personalizzato con il privilegio di webhook organizzazione.
2. Accedi a Organizzazione > Impostazioni > Webhook.
3. In Webhook organizzazione, fare clic su Crea webhook.
4. Nella finestra Crea webhook, eseguire le seguenti operazioni:
   1. Immetti un nome univoco per il webhook nella casella di testo Nome.
   2. Selezionare un tipo di webhook dal menu a discesa Tipo.
      • Selezionando Tutti si effettua la sottoscrizione a tutti i trigger di eventi supportati. Riceverai notifiche per ciascun evento quando si verifica.
      • Selezionando Elementi, Utenti, Gruppi o Ruoli è possibile definire manualmente gli attivatori degli eventi a cui abbonarsi.
   3. Se si seleziona un tipo di webhook diverso da Tutti, comparirà un ulteriore menu a discesa relativo al tipo di webhook che è stato scelto. Ad esempio, se si è selezionato Elementi per il tipo di webhook, compare il menu a discesa Elementi che consente di selezionare un elemento specifico che verrà monitorato dal webhook.
   4. Selezionare gli attivatori di eventi dal menu a discesa Eventi. Ad esempio, se si desidera che il webhook venga invocato quando un elemento specifico viene pubblicato, selezionare /items/<ID elemento>/publish.
   5. Selezionare un tipo di ricevitore webhook.
      • Se si seleziona URL webhook, fornire l'URL di payload per il ricevitore webhook. Di seguito viene illustrato un esempio di URL di payload:
        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

      • Se si seleziona Notebook, scegliere il notebook che verrà eseguito quando il webhook verrà attivato.

        Nota:

        Se l'opzione Notebook non è disponibile, non è stato configurato alcun Notebook Server con il portale. Se l'opzione è disponibile ma non può essere selezionata, non sono disponibili notebook adatti per la configurazione di webhook. Devi possedere un elemento notebook che verrà utilizzato per il webhook.

   6. Facoltativamente, impostare un valore segreto per il webhook nella casella di testo Segreto (facoltativo). Il valore segreto sarà usato per generare una firma inclusa nelle intestazioni di payload del webhook. Il ricevitore del webhook può utilizzare questa firma per stabilire se il messaggio può essere ritenuto attendibile.
5. Fare clic su Crea webhook.

Configurare parametri avanzati per i webhook dell'organizzazione

Le impostazioni avanzate applicate ai webhook dell'organizzazione consentono di personalizzare ulteriormente le prestazioni dei webhook, ad esempio specificando il numero di tentativi di consegna, l'ora di notifica e il tempo tra tentativi di consegna.

Per impostare proprietà avanzate tramite il sito Web del portale ArcGIS Enterprise, eseguire le seguenti operazioni:

1. Effettuare l'accesso all'organizzazione come amministratore predefinito o come ruolo personalizzato con il privilegio di webhook organizzazione.
2. Accedi a Organizzazione > Impostazioni > Webhook.
3. In Webhook organizzazione, fare clic su Impostazioni webhook avanzate.
4. Nella finestra Impostazioni webhook avanzate, eseguire le seguenti operazioni:
   1. Impostare un valore per Numero di tentativi di consegna.

      Il valore specifica il numero di tentativi che saranno effettuati per consegnare i payload di webhook. Per impostazione predefinita il portale ArcGIS Enterprise tenta di consegnare i payload 3 volte. Il valore specificato per i tentativi deve essere un intero da 0 a 5.

   2. Impostare un valore per Timeout notifica.

      Questo valore specifica il tempo, in secondi, per cui il portale ArcGIS Enterprise attende di ricevere una risposta dal ricevitore. Per impostazione predefinita, il portale ArcGIS Enterprise attenderà 10 secondi. Il valore per il numero di secondi di attesa del portale ArcGIS Enterprise deve essere un intero da 0 a 60 secondi.

   3. Impostare un valore per Tempo trascorso notifica.

      Questo valore specifica la quantità di tempo, in secondi, tra due tentativi di consegna del payload. Per impostazione predefinita, il portale ArcGIS Enterprise tenta di consegnare il payload dopo 5 secondi se il tentativo precedente non riesce fino a raggiungere il numero massimo di tentativi specificato in Numero di tentativi di consegna.

5. Una volta configurate le precedenti impostazioni, fare clic su Salva.

   Le proprietà aggiornate verranno applicate a tutti i webhook configurati dell'organizzazione.

Configurare i webhook del servizio

I webhook del servizio consentono di abbonarsi ad attivatori per gli eventi associati ai fature service dell'organizzazione o al completamento dei processi del servizio di geoprocessing.

Creare un webhook del servizio

Per creare un webhook per un servizio di geoprocessing o un feature service, effettuare questi passaggi:

1. Accedere all'organizzazione come amministratore predefinito o membro di un ruolo personalizzato con privilegi di creazione e gestione dei webhook del servizio.

   Nota:

   I membri assegnati al ruolo di publisher non potranno creare o gestire i webhook del servizio dal sito del portale ArcGIS Enterprise e dovranno eseguire questi flussi di lavoro di tramite l'API amministrativa. Flussi di lavoro di

2. Accedi a Organizzazione > Impostazioni > Webhook.
3. In Webhook del servizio, fare clic su Crea webhook.
4. Nella finestra Crea webhook, eseguire le seguenti operazioni:
   1. Immetti un nome univoco per il webhook nella casella di testo Nome.
   2. Selezionare un servizio dal menu a discesa Servizio.

      Nota:

      Selezionando un servizio di geoprocessing si imposta l'evento come Servizio terminato Selezionando un feature service si abilita il menu a discesa Eventi.

   3. Se si seleziona un webhook di feature service, selezionare un attivatore di eventi dal menu a discesa Eventi. Ad esempio, se si desidera che il webhook venga richiamato quando una modifica include un nuovo allegato, selezionare AttachmentsCreated.
   4. Fornire l'URL di payload per il ricevitore webhook nella casella di testo URL webhook. Di seguito viene illustrato un esempio di URL di payload:
      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. Facoltativamente, impostare un valore segreto per il webhook nella casella di testo Segreto (facoltativo). Il valore segreto sarà usato per generare una firma inclusa nelle intestazioni di payload del webhook. Il ricevitore del webhook può utilizzare questa firma per stabilire se il messaggio può essere ritenuto attendibile.
5. Fare clic su Crea webhook.

Configurare parametri avanzati per i webhook del servizio

Le impostazioni avanzate applicate ai webhook del servizio consentono di personalizzare ulteriormente le prestazioni dei webhook, ad esempio specificando il numero di tentativi di consegna, l'ora di notifica e il tempo tra tentativi di consegna.

Per impostare proprietà avanzate tramite il sito Web del portale ArcGIS Enterprise, eseguire le seguenti operazioni:

1. Accedere all'organizzazione come amministratore predefinito o membro di un ruolo personalizzato con privilegi di creazione e gestione dei webhook del servizio.

   Nota:

   I membri assegnati al ruolo di publisher non potranno creare o gestire i webhook del servizio dal sito del portale ArcGIS Enterprise e dovranno eseguire questi flussi di lavoro di tramite l'API amministrativa. Flussi di lavoro di

2. Accedi a Organizzazione > Impostazioni > Webhook.
3. In Webhook servizio, fare clic su Impostazioni webhook avanzate.
4. Nella finestra Impostazioni webhook avanzate, eseguire le seguenti operazioni:
   1. Impostare un valore per Numero di tentativi di consegna.

      Il valore specifica il numero di tentativi che saranno effettuati per consegnare i payload di webhook. Per impostazione predefinita il sistema tenta di consegnare i payload 3 volte. Il valore specificato per i tentativi deve essere un intero da 0 a 5.

   2. Impostare un valore per Timeout notifica.

      Questo valore specifica il tempo, in secondi, per cui il sistema attende di ricevere una risposta dal ricevitore. Per impostazione predefinita, il sistema attende 10 secondi. Il valore deve essere un intero da 0 a 60 secondi.

   3. Impostare un valore per Tempo trascorso notifica.

      Questo valore specifica la quantità di tempo, in secondi, tra due tentativi di consegna del payload. Per impostazione predefinita, il sistema tenta di consegnare il payload dopo 5 secondi se il tentativo precedente non riesce fino a raggiungere il numero massimo di tentativi specificato in Numero di tentativi di consegna.

   4. Impostare un valore per Numero passato di giorni.

      Il valore specifica il numero di giorni in cui può verificarsi uno specifico numero di errori prima che il webhook venga disattivato. Per impostazione predefinita, il sistema accetta uno specifico numero di errori (specificato in Numero massimo di errori) nel corso dei 5 giorni. Il valore deve essere un intero compreso tra 1 e 30.

   5. Impostare un valore per Numero massimo di errori.

      Il valore specifica il numero di errori che possono verificarsi in uno specifico numero di giorni prima che il webhook venga disattivato. Per impostazione predefinita, il sistema accetta 5 errori in un numero di giorni specificato in Numero massimo di errori prima che i webhook vengano disattivati. Il valore deve essere un intero compreso tra 1 e 30.

5. Una volta configurate le precedenti impostazioni, fare clic su Salva.

   Le proprietà aggiornate saranno applicate a tutti i webhook configurati dell'organizzazione.