Vai al contenuto principale Passa a contenuto complementare

Creazione di webhook per flussi di lavoro

I webhook forniscono un modo per utilizzare gli eventi di sistema di Qlik Cloud come trigger nel flusso di lavoro dell'utente. Quando si crea un webhook, questo invia automaticamente una richiesta JSON all'endpoint webhook in qualsiasi momento si verifichi l'evento di sistema definito. È possibile utilizzare i webhook per inviare dati degli eventi a qualsiasi applicazione in grado di ricevere dati JSON.

Proprietà webhook

Per creare un webhook, è necessario configurare le proprietà di webhook ed endpoint e scegliere i tipi di evento Qlik Cloud.

Proprietà webhook
Proprietà Descrizione
Nome Nome del webhook.
Descrizione (opzionale) Descrizione del webhook.
URL URL per endpoint webhook. L'URL (endpoint webhook) deve essere un nome di dominio completo (FDQN) e deve utilizzare il protocollo HTTPS. L'endpoint non può essere un indirizzo IP.
Segreto (opzionale) Segreto per l'autenticazione webhook. Il segreto deve essere composto da un minimo di 32 caratteri e un massimo di 64 caratteri. Se si crea un segreto webhook, farà parte di un hash aggiunto alla richiesta HTTP come qlik-signature.
Intestazioni (opzionali)

Intestazioni che possono essere aggiunte alla richiesta HTTP.

Ciascun webhook è configurato con uno o più tipi di evento.

Tipi di evento per webhook
Risorsa Tipi di evento
App Creato, Eliminato, Dati caricati, Ricaricato, Pubblicato, Esportato
Nota informaticaUn evento di aggiornamento dati fa riferimento all'aggiornamento dei dati. Un evento di ricaricamento fa riferimento all'app Qlik Sense e al ricaricamento delle tabelle dati associate.
Utenti Creato, Eliminato

Il webhook attende che si verifichi uno degli eventi, e quando ciò accade, invia i dati evento all'endpoint webhook. I dati vengono trasferiti all'URL endpoint come una richiesta JSON.

Nota informaticaPer saperne di più sui payload evento, vedere Portale Qlik Developer: Eventi API.

Esempio: Richiesta JSON per il tipo di evento eliminazione app

Request
URL
https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx
Headers
{
    "Content-Type": "application/json",
    "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
    "User-Agent": "Qlik Webhook"
}
Body
{
    "cloudEventsVersion": "0.1",
    "source": "com.qlik/engine",
    "contentType": "application/json",
    "eventId": "e65c1481-e8a-4be-a5ca-27dfcde077d7",
    "eventTime": "2021-03-08T14:51:29Z",
    "eventTypeVersion": "1.0.0",
    "eventType": "com.qlik.v1.app.deleted",
    "extensions": {
        "ownerId": "vNRGrDZIypJzauw59BbpvkRhqbmI",
        "tenantId": "oZcMPa_1PwH4FUdrh6839YHHdEJN",
        "userId": "vNRGrDZIypJtcGTzauw59BbpqbmI"
    },
    "data": {
        "attributes": {
            "id": "0984fec4-aa8c-4253-b1d1-4fd4f9c78",
            "name": "New App",
            "createdDate": "2021-03-08T14:51:28.888Z",
            "modifiedDate": "2021-03-08T14:51:29.316Z",
            "owner": "auth0|b62a17c577a4abe6e807b07d18c4d82286352542d633d120100b03fb11",
            "ownerId": "vNRGrDZIypJtcGTzauw59BbpvbmI",
            "published": false,
            "hasSectionAccess": false
        }
    }
}

Creazione di un webhook

È possibile creare webhook in Console di gestione. È anche possibile creare webhook dall'interfaccia Qlik Application Automation. Per ulteriori informazioni, vedere Utilizzo dei webhook (solo in lingua inglese).

È possibile creare un massimo di 100 webhook per ciascun tenant.

  1. In Console di gestione, andare a Webhook.

  2. Nell'angolo in alto a destra, fare clic su Crea nuovo.

  3. Nella finestra di dialogo Crea webhook, inserire un nome per il webhook.

  4. Aggiungere una descrizione opzionale.

  5. Inserire l'URL per l'applicazione di integrazione di terze parti.

  6. In via opzionale, inserire il segreto da aggiungere alla richiesta HTTP.

  7. In via opzionale, aggiungere intestazioni HTTP da aggiungere alla richiesta.

  8. Sotto Eventi, selezionare il tipo di evento per il webhook.

  9. Al termine, fare clic su Crea.

    I webhook sono elencati in una tabella. I webhook recentemente creati sono attivati per impostazione predefinita.

Tabella dei webhook della Console di gestione
Nota di suggerimentoÈ possibile attivare o disattivare un webhook facendo clic sul pulsante Icona IU con tre puntini per aprire il menu opzioni per il webhook al termine della riga webhook e selezionando Abilita webhook o Disabilita webhook. I webhook sono attivati per impostazione predefinita.
Nota di suggerimentoÈ possibile ordinare e cercare i webhook nella tabella facendo clic sull'icona Icona freccia su-giù per ordinare i valori delle colonne nella parte superiore di qualsiasi colonna per modificare il criterio di ordinamento, oppure fare clic sull'icona filtro Icona filtro in cima a ciascuna colonna webhook in cima a ciascuna colonna per cercare manualmente un webhook. Il filtro di ricerca funziona per le corrispondenze sia totali sia parziali.

Modifica di un webhook

  1. In Console di gestione, andare a Webhook.

  2. Per il webhook che si desidera modificare, fare clic sul pulsante Icona IU con tre puntini per aprire il menu opzioni per il webhook al termine della riga.

  3. Fare clic su Modifica.

    Il pannello di modifica viene visualizzato insieme ad opzioni per modificare la configurazione webhook.

  4. Effettuare le proprie modifiche e fare clic su Salva.

Eliminazione di un webhook

  1. In Console di gestione, andare a Webhook.

  2. Selezionare il webhook da eliminare.

  3. Nell'angolo superiore destro, fare clic su Elimina.

  4. Si apre una finestra di dialogo pop-up per confermare la propria scelta. Fare clic su Elimina.

Visualizzazione della cronologia webhook

È possibile accedere alla cronologia webhook in Webhook in Console di gestione.

Nota informaticaLe consegne degli eventi vengono rimosse dalla cronologia webhook dopo 7 giorni.
  • Per visualizzare la cronologia webhook, fare clic sul pulsante Icona IU freccia giù per espandere il menu webhook al termine della riga webhook.

    Viene visualizzata la cronologia webhook.

    Cronologia webhook della Console di gestione

  • Per inviare di nuovo manualmente una consegna evento, fare clic sul pulsante Icona Invia di nuovo utilizzata per inviare nuovamente il webhook al termine della riga evento.

  • Per visualizzare il payload di risposta evento, fare clic sul pulsante Icona IU freccia giù per espandere il menu payload evento al termine della riga evento.

    Informazioni sul payload del tipo di evento webhook della Console di gestione

Ulteriori informazioni

Hai trovato utile questa pagina?

Se riscontri problemi con questa pagina o con il suo contenuto – un errore di battitura, un passaggio mancante o un errore tecnico – facci sapere come possiamo migliorare!