Configurare i Webhook

Verifica che il sistema esterno possa ricevere correttamente i dati all'indirizzo indicato.

Un webhook invia automaticamente dati e aggiornamenti dalla piattaforma a un sistema esterno. Puoi usarlo per integrare altri applicativi e mantenere le informazioni aggiornate in tempo reale. Dopo la configurazione, l'invio avviene senza esportazioni manuali.

Accedere alla sezione Webhook

Per accedere alla configurazione dei webhook, clicca su Impostazioni e poi sulla voce Webhook

Apri la sezione Webhook per visualizzare le configurazioni esistenti. Da qui puoi anche crearne una nuova.

L'elenco mostra tutti i webhook già configurati.

Creare un webhook

Per creare un webhook, clicca su Crea webhook.

Compilare i dati

Usa un nome chiaro. Sarà più semplice trovare il webhook quando dovrai modificarlo.

Compila i campi richiesti dal sistema esterno che riceverà i dati. In genere devi indicare:

• Nome (obbligatorio): un nome che permetta di riconoscere facilmente il webhook;

• Endpoint (obbligatorio): l'URL di destinazione a cui la piattaforma invia i dati;

• Method (obbligatorio): il metodo HTTP con cui inviare la richiesta (es. POST);

• Attivatore (obbligatorio): l'evento che scatena l'invio del webhook. Puoi scegliere Tutti oppure un evento specifico tra: Pratica pagata, Pratica inviata, Pratica acquisita, Pratica protocollata, Pratica presa in carico, Richiesta integrazioni, In attesa di integrazioni, Integrazioni concluse, Pratica protocollata dopo integrazioni, Pratica approvata, Pratica rifiutata, Pratica ritirata, Pratica annullata, Messaggio creato, Modulo operatore aggiornato;

• Servizi abilitati: seleziona i servizi per cui il webhook deve attivarsi. Puoi aggiungere i servizi uno alla volta, usare Aggiungi tutti per includerli tutti oppure Rimuovi tutti per svuotare la selezione;

• Headers (json): eventuali header HTTP da inviare con la richiesta, in formato JSON (ad esempio l'header di autenticazione Authorization richiesto dal sistema esterno);

• Versione (obbligatorio): la versione del formato dei dati inviati (1.0 oppure 2.0).
• Attivo: spunta questa casella per rendere operativo il webhook. Se deselezionata, il webhook resta configurato ma non invia dati.
• Test (facoltativo): prima di salvare puoi inserire l'Id di una pratica e usare il pulsante Test per verificare che l'invio verso l'endpoint funzioni correttamente.

Salvare il webhook

Al termine della configurazione, clicca su Salva.

Prima di salvare, verifica che l'endpoint esterno sia corretto e raggiungibile. Se l'indirizzo non è valido, idati non vengono inviati.

Caso d'uso: popolamento automatico della mappa delle segnalazioni

Per attivare questo caso d'uso, l'Ente deve disporre di:

• il sito fornito da OpenCity;
• il servizio Helpdesk di Segnalazione disservizio.

Un caso d'uso dei webhook è l'aggiornamento automatico del dataset della mappa pubblica delle segnalazioni. È disponibile nel servizio di Segnalazione disservizi.

Quando l'operatore rende pubblica una segnalazione, l'evento attiva il webhook. Il webhook invia al sito dell'Ente i dati georeferenziati e anonimizzati. Il sito riceve i dati e aggiorna la mappa senza interventi manuali.

I cittadini possono così consultare le segnalazioni pubblicate sul territorio. L'Ente offre informazioni aggiornate e rende più trasparenti i disservizi segnalati.