Un amministratore può configurare webhook per la distribuzione 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 del servizio, la organizzazione deve usare ArcGIS Enterprise 11.0 o versione successiva.
- Per creare e gestire i webhook dell'organizzazione, è necessario essere un amministratore o avere il ruolo di amministratore predefinito assegnato.
- Per creare e gestire i webhook del servizio, è necessario disporre dei privilegi di amministratore Aggiorna, Elimina, Sicurezza e infrastruttura o Server oppure avere il ruolo di amministratore predefinito assegnato.
- 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, il servizio deve includere la funzionalità di Modifica e il monitoraggio delle modifiche deve essere abilitato senza sincronizzazione.
- Per configurare webhook per il servizio di geoprocessing, il servizio deve essere asincrono.
Nota:
In questa release, i webhook del servizio sono funzioni in versione beta. Le funzioni beta potrebbero non essere complete per cui potrebbero presentare problemi di prestazioni o qualità noti e non sono coperte dal Supporto tecnico Esri. La documentazione API beta per i webhook dei servizi è disponibile nella Guida API amministratore dei webhook dei servizi PDF. Per ulteriori informazioni sulle funzioni in versione beta in ArcGIS Enterprise, vedi Funzionalità beta.
Creare un webhook dell'organizzazione
I webhook dell'organizzazione consentono di abbonarsi a trigger per eventi associati a elementi, gruppi e utenti del portale ArcGIS Enterprise.
Nota:
Per una richiesta POST di esempio che crea un webhook su eventi correlati a utenti, gruppi ed elementi, consulta la documentazione della REST API Crea webhook.
Per creare un webhook per l'organizzazione, effettua questi passaggi:
- Passa a Directory di Portal for ArcGIS e accedi come membro con ruolo di amministratore.
I webhook possono essere creati e gestiti solo dagli amministratori o dai membri a cui è stato assegnato il ruolo di amministratore predefinito.
https://machine.domain.com/webadaptor/sharing/restUna volta effettuato l'accesso, viene visualizzata la pagina delle risorse Utente per il tuo account.
- Fai clic sul collegamento ipertestuale ID org oppure effettua una richiesta del seguente modulo per accedere alla pagina delle risorse Autoportale:
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Scorri verso il basso nella pagina delle risorse Self e fai clic su Webhook > Crea webhook per accedere all'operazione Crea webhook.
- Una volta raggiunto l'endpoint Crea webhook, fornisci le seguenti informazioni:
- Immetti un nome univoco per il webhook nella casella di testo Nome.
- Immetti l'URL di payload per il ricevitore di webhook nella casella di testo URL payload, in qui sarà eseguita un'interrogazione quando viene creato il webhook per garantire che possa essere stabilita la connessione tra il ricevitore e il portale ArcGIS Enterprise.
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 - Facoltativamente, imposta un segreto per il webhook che possa essere utilizzato per autenticare i messaggi del webhook con il ricevitore. Inserisci la stringa alfanumerica definita dall'utente nella casella di testo Segreto (facoltativo).
- Facoltativamente, specifica le informazioni di disattivazione per il webhook nella casella di testo Proprietà di configurazione.
Per impostazione predefinita il webhook si disattiva se si verificano cinque errori nel corso di cinque giorni.
- In Quali eventi attivano questo webhook, seleziona Definiti manualmente o Inviami tutto.
- Se scegli Definiti manualmente, elenca gli eventi trigger che saranno utilizzati per questo webhook nella casella di testo Inviami modifiche per questi eventi separati da virgole. Ad esempio, per abbonarti a tutti li eventi relativi a uno specifico gruppo dell'organizzazione, inserisci un evento trigger simile a quello di seguito illustrato, dove [groupID] rappresenta l'ID univoco associato a un gruppo specifico:
/groups/[groupID]/update - Se scegli Inviami tutto, ti abbonerai a tutti gli eventi trigger supportati. Riceverai notifiche per ciascun evento quando si verifica.
- Se scegli Definiti manualmente, elenca gli eventi trigger che saranno utilizzati per questo webhook nella casella di testo Inviami modifiche per questi eventi separati da virgole. Ad esempio, per abbonarti a tutti li eventi relativi a uno specifico gruppo dell'organizzazione, inserisci un evento trigger simile a quello di seguito illustrato, dove [groupID] rappresenta l'ID univoco associato a un gruppo specifico:
- Una volta configurati i parametri precedenti, fai clic su Crea webhook per inviare la richiesta.
Una volta completata l'operazione, un nuovo webhook sarà aggiunto all'organizzazione.
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.
Nota:
Per visualizzare una richiesta POST di esempio che configura queste proprietà avanzate, consulta la documentazione della REST API Aggiorna impostazioni webhook.
Per impostare queste proprietà avanzate, procedi nel modo seguente:
- Passa a Directory di Portal for ArcGIS e accedi come membro con ruolo di amministratore. I webhook possono essere creati e gestiti solo dagli amministratori o dai membri a cui è stato assegnato il ruolo di amministratore predefinito.
https://machine.domain.com/webadaptor/sharing/restUna volta effettuato l'accesso, viene visualizzata la pagina delle risorse Utente per il tuo account.
- Fai clic sul collegamento ipertestuale ID org oppure effettua una richiesta del seguente modulo per accedere alla pagina delle risorse Autoportale:
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Scorri verso il basso nella pagina delle risorse Self e fai clic su Webhook > Impostazioni > Aggiorna per accedere all'operazione Aggiorna impostazioni webhook.
- Una volta raggiunto l'endpoint Aggiorna impostazioni webhook, fornisci le seguenti informazioni:
- Imposta un valore per Numero di tentativi di notifica.
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 tre volte. Il valore specificato per i tentativi deve essere in intero da 0 a 5.
- Imposta un valore per Timeout notifica in secondi.
Questo valore specifica il tempo, in secondi, per cui il portale ArcGIS Enterprise attende di ricevere una risposta dal ricevitore. Per impostazione predefinita, il portaleArcGIS Enterprise attende 10 secondi. Il valore per il numero di secondi di attesa del portale ArcGIS Enterprise deve essere un intero da 0 a 60 secondi.
- Imposta un valore per Tempo trascorso notifica in secondi.
Questo valore specifica la quantità di tempo, in secondi, tra due tentativi di consegna del payload. Per impostazione predefinita, il portale ArcGIS Enterprise tenta 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 notifica.
- Imposta un valore per Numero di tentativi di notifica.
- Una volta configurati i parametri precedenti, fai clic su Aggiorna impostazioni webhook per inviare la richiesta.
Al termine dell'operazione, le proprietà aggiornate saranno applicate a ogni webhook dell'organizzazione specificato.
Creare un webhook del servizio di geoprocessing
I webhook del servizio di geoprocessing consentono di abbonarsi a specifici trigger di eventi con i servizi di geoprocessing.
Nota:
Per un esempio di richiesta POST che crea un webhook per i servizi di geoprocessing, consultare la documentazione della REST API beta del webhook nella Guida API amministratore dei webhook dei servizi PDF.
Per creare un webhook per il servizio di geoprocessing, effettua questi passaggi:
- Passa a ArcGIS Server Administrator Directory e accedi come membro con i privilegi appropriati assegnati.I webhook possono essere creati e gestiti solo dagli amministratori con privilegi di amministratore Aggiorna, Elimina, Sicurezza e infrastruttura o Server o a cui è stato assegnato il ruolo di amministratore predefinito.
https://machine.domain.com/webadaptor/admin - Una volta eseguito l'accesso, passa alla risorsa Webhook per un servizio di geoprocessing facendo clic su Servizi > [NomeServizio] > Webhook > Crea, dove [ServiceName] rappresenta il servizio per cui sarà creato il webhook. Per i servizi ospitati in specifiche cartelle, fai clic su Servizi > [NomeCartella] > [NomeServizio] > Webhook > Crea, dove [FolderName] rappresenta la cartella in cui si trova il servizio.
Attenzione:
Per configurare webhook per il servizio di geoprocessing, il servizio deve essere asincrono.
- Una volta raggiunto l'endpoint Crea webhook, fornisci le seguenti informazioni:
- Immetti un nome univoco per il webhook nella casella di testo Nome. Il nome fornito può contenere solo valori alfanumerici; i caratteri speciali determineranno una risposta di errore.
- Facoltativamente, imposta un segreto per il webhook che possa essere utilizzato per autenticare i messaggi del webhook con il ricevitore. Digita la stringa alfanumerica definita dall'utente nella casella di testo Chiave di firma.
- Fornisci l'URL di payload per il ricevitore di webhook nella casella di testo URL hook, in cui sarà eseguita l'interrogazione quando viene creato il webhook per garantire che possa essere stabilita la connessione tra il ricevitore eArcGIS Server della distribuzione. Di seguito viene illustrato un payload di esempio:
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 - Opzionalmente, specifica il tipo di supporto. Nel menu a discesa Tipo di contenuto, scegli una delle seguenti opzioni:
- application/json (predefinito)
- application/x-www-form-urlencoded
- Facoltativamente, definisci il formato del payload. Nel menu a discesa Formato payload, scegli una delle seguenti opzioni:
- JSON (predefinito)
- PJSON
- Facoltativamente, usa il parametro Attivo per disabilitare o abilitare le richiamate quando viene attivato il webhook. Per abilitare, seleziona Vero. Per disabilitare, seleziona Falso.
Per impostazione predefinita le richiamate sono abilitate.
- Una volta configurati i parametri precedenti, fai clic su Crea per inviare la richiesta.
Al termine dell'operazione, un nuovo webhook viene applicato allo specifico servizio di geoprocessing.
Nota:
Diversamente dai webhook dell'organizzazione e feature service, i webhook del servizio di geoprocessing non presentano trigger di eventi definiti dall'utente. I webhook del servizio di geoprocessing consegnano i payload una volta completato il processo di geoprocessing. Per ulteriori informazioni sui payload consegnati per i servizi di geoprocessing, vedi l'argomento Payload.Creare un webhook di feature service
I webhook di feature service consentono di abbonarsi a specifici trigger di eventi associati ai feature service.
Nota:
Per un esempio di richiesta POST che crea un webhook per feature service, consultare la documentazione della REST API beta del webhook nella Guida API amministratore dei webhook dei servizi PDF.
Per creare un webhook per un feature service servizio, effettua questi passaggi:
- Passa a ArcGIS Server Administrator Directory e accedi come membro con i privilegi appropriati assegnati.
I webhook possono essere creati e gestiti solo dagli amministratori con privilegi di amministratore Aggiorna, Elimina, Sicurezza e infrastruttura o Server o a cui è stato assegnato il ruolo di amministratore predefinito.
https://machine.domain.com/webadaptor/admin - Una volta eseguito l'accesso, passa alla risorsa Webhook per un feature service facendo clic su Servizi > [NomeServizio] > Webhook > Crea, dove [ServiceName] rappresenta il servizio per cui sarà creato il webhook. Per i servizi ospitati in specifiche cartelle, fai clic su Servizi > [NomeCartella] > [NomeServizio] > Webhook > Crea, dove [FolderName] rappresenta la cartella in cui si trova il servizio.
Attenzione:
Per configurare webhook per un feature service, il feature service deve includere la funzionalità di Modifica e il monitoraggio traccia delle modifiche deve essere abilitato senza sincronizzazione.
- Una volta raggiunto l'endpoint Crea webhook, fornisci le seguenti informazioni:
- Immetti un nome univoco per il webhook nella casella di testo Nome. Il nome fornito può contenere solo valori alfanumerici; i caratteri speciali determineranno una risposta di errore.
- Elenca i trigger di eventi che saranno utilizzati per questo webhook nella casella di testo Tipo di modifica. Ad esempio, per richiamare il webhook quando viene creato un feature service, utilizza il seguente trigger di eventi:
Esempio
FeaturesCreated - Facoltativamente, imposta un segreto per il webhook che possa essere utilizzato per autenticare i messaggi del webhook con il ricevitore. Digita la stringa alfanumerica definita dall'utente nella casella di testo Chiave di firma.
- Fornisci l'URL di payload per il ricevitore di webhook nella casella di testo URL hook, in cui sarà eseguita l'interrogazione quando viene creato il webhook per garantire che possa essere stabilita la connessione tra il ricevitore eArcGIS Server della distribuzione. Di seguito viene illustrato un payload di esempio:
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 - Opzionalmente, specifica il tipo di supporto. Nel menu a discesa Tipo di contenuto, scegli una delle seguenti opzioni:
- application/json (predefinito)
- application/x-www-form-urlencoded
- Facoltativamente, definisci il formato del payload. Nel menu a discesa Formato payload, scegli una delle seguenti opzioni:
- JSON (predefinito)
- PJSON
- Facoltativamente, usa il parametro Attivo per disabilitare o abilitare le richiamate quando viene attivato il webhook. Per abilitare, seleziona Vero. Per disabilitare, seleziona Falso.
Per impostazione predefinita le richiamate sono abilitate.
- Regola la pianificazione per i webhook modificando il valore di Secondi nella casella di testo Pianifica. Per i feature service che sperimentano modifiche frequenti, abbassa il valore di Secondi per ricevere webhook più frequenti con meno informazioni sull'evento nel payload. Per i feature service che non sperimentano modifiche frequenti, aumenta il valore della proprietà Secondi per ricevere webhook meno frequenti con più informazioni sull'evento contenute nel payload.
Il valore minimo, e predefinito, per la pianificazione è 20 secondi.
- Una volta configurati i parametri precedenti, fai clic su Crea per inviare la richiesta.
Al termine dell'operazione, un nuovo webhook viene applicato allo specifico feature service.