Il webhook è un metodo che consente a un'applicazione o servizio Web di inviare informazioni quasi in tempo reale a un altro web service. La comunicazione viene attivata da uno o più eventi specifici definiti dall'utente. Invece di verificare ripetutamente la presenza di aggiornamenti, il sistema consegna una notifica non appena si verifica l'evento di attivazione.
In ArcGIS Online, i webhook possono essere creati per i feature layer ospitati, le viste di feature layer ospitati e le tabelle ospitate. Questi webhook inviano dei payload al ricevitore webhook in base a trigger di evento definiti. Il ricevitore è configurato per eseguire azioni automatizzate, come notificare una lista predefinita di destinatari riguardo alle modifiche, esportare le informazioni sulle modifiche a un'app esterna per creare report dei cambiamenti o eseguire script di controllo qualità sui dati modificati.
I componenti di questo canale di comunicazione sono i seguenti:
- Trigger di evento: ogni trigger di evento specifica delle operazioni API, eseguite sul feature service di origine dell'elemento, che invocano il webhook. Quando un utente esegue un'operazione indicata come trigger di evento, il webhook consegna tali informazioni (sotto forma di payload) al ricevitore webhook. I trigger sono specificati quando si crea il webhook. Consultare Trigger di evento dei feature layer per informazioni sugli specifici trigger di evento che è possibile impostare.
- Payload: il payload contiene le informazioni riguardanti l'evento di azionamento. Consultare Payload webhook dei feature layer per informazioni su ciò che è incluso in un payload.
- Ricevitore webhook: il ricevitore webhook accetta il payload e invia informazioni a un elenco predefinito di destinatari (utenti o app). Ad esempio, può inviare un'email o un messaggio di testo che informa l'utente che l'evento di azionamento si è verificato, inviare le informazioni sull'evento di azionamento a un database esterno per l'archiviazione o eseguire uno script sui dati in base all'evento che si è verificato.
È possibile utilizzare ricevitori web service di terze parti o web service personalizzati per i ricevitori webhook. È necessario configurare i ricevitori webhook per comunicare tramite una connessione HTTPS per ricevere i payload e l'organizzazione ArcGIS Online deve essere in grado di accedere ai ricevitori prima di poter aggiungere un webhook a un elemento. Il ricevitore webhook è accessibile tramite l'URL del payload specificato quando si crea il webhook.
Il ricevitore webhook è configurato esternamente a ArcGIS Online. Dopo aver configurato il ricevitore, è possibile creare un webhook.
Requisiti
Prima di poter creare un webhook per un feature layer, vista o tabella ospitati, l'elemento deve soddisfare i seguenti requisiti:
- L'impostazione Tieni traccia delle modifiche ai dati (aggiungi, aggiorna, cancella le feature) deve essere abilitata.
- L'elemento non può essere nel cestino.
Ogni elemento può avere fino a 10 webhook.
Creazione del webhook
I tipi di membri dell'organizzazione che possono creare e gestire i webhook per i feature layer ospitati, viste di feature layer ospitati e tabelle ospitate sono elencati nella seguente tabella, assieme alle informazioni sul luogo in cui possono gestire i webhook.
| Tipo di membro dell'organizzazione | Luogo in cui possono essere gestiti i webhook |
|---|---|
Membri del ruolo amministratore predefinito o membri di un ruolo personalizzato che dispone dell'insieme di privilegi amministrativi necessari per creare e gestire i webhook. |
|
Proprietari dell'elemento |
|
I membri di un gruppo di aggiornamento condiviso con i quali è stato condiviso l'elemento. | La scheda Impostazioni della pagina dell'elemento di un feature layer, vista o tabella ospitati: il membro del gruppo può creare e gestire webhook per l'elemento specifico. |
Seguire le istruzioni a seconda del proprio ruolo nell'organizzazione per creare un webhook:
- Amministratore dell'organizzazione
- Proprietario dell'elemento o membro di un gruppo di aggiornamento condiviso con il quale è stato condiviso l'elemento.