Creazione e gestione di webhook per i flussi di lavoro

Autorizzazioni webhook richieste

Quando si creano o si gestiscono i webhook utilizzando l'API Webhooks di Qlik Cloud e l'interfaccia utente delle automazioni, è necessario richiedere una o entrambe queste autorizzazioni:

• Usa webhook: necessaria per creare, visualizzare, aggiornare ed eliminare i webhook di proprietà dell'utente.

• Gestisci webhook: necessaria per gestire tutti i webhook nel tenant, inclusi quelli creati da altri utenti.

Come funzionano i webhook

Quando si verifica un evento in Qlik Cloud (ad esempio, viene creata una nuova applicazione o viene eliminato un utente), un webhook invia informazioni in formato JSON a un'applicazione esterna specificata utilizzando un callback HTTP. Questa applicazione esterna può quindi utilizzare i dati dell'evento per attivare ulteriori azioni.

Ad esempio:

• Avvisare il team tramite Slack quando viene creata una nuova applicazione.

• Inviare automaticamente un'e-mail di benvenuto quando un nuovo membro del team viene aggiunto a un tenant.

• Aggiornare un foglio di calcolo quando un utente viene eliminato dal tenant.

Vantaggi dell'utilizzo dei webhook

I webhook consentono l'integrazione in tempo reale con altri sistemi, eliminando la necessità di controlli manuali costanti o richieste API ripetitive. Ascoltando gli eventi e inviando immediatamente i dati rilevanti, i webhook riducono il lavoro non necessario e consentono un'automazione fluida.

Piattaforme popolari per le integrazioni di webhook

Per gestire e rispondere ai dati dei webhook, è possibile creare servizi personalizzati o utilizzare piattaforme di terze parti come:

• Qlik Automate (solo in lingua inglese)

• Pipedream

• Zapier

• Microsoft Power Automate

https://<your-tenantURL>/api/v1/webhooks/{id}

{
    "Content-Type": "application/json",
    "X-Execution-Token: <your-execution-token>",
    "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
    "User-Agent": "Qlik Webhook"
}

{
    "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 webhook

I webhook possono essere creati da:

• Amministratori del tenant dal centro attività Amministrazione.

• Tutti gli utenti dall'interfaccia Qlik Automate.

Per ulteriori informazioni sull'utilizzo dei webhook con Qlik Automate, vedere Lavorare con i webhook (solo in lingua inglese).

Procedere come indicato di seguito:

1. Nel centro attività Amministrazione, andare su Webhook.

2. Fare clic su Crea nuovo.

3. Inserire un nome per il webhook e, facoltativamente, aggiungere una descrizione.

4. Per URL (endpoint), inserire il nome di dominio completo (FQDN) a cui il webhook invierà i dati JSON.

   • Questo URL deve utilizzare il protocollo HTTPS (esempio: https://domain.com). Gli indirizzi IP non possono essere utilizzati come endpoint del webhook.

5. Facoltativamente, inserire un segreto per l'autenticazione del webhook.

   • Il segreto deve essere compreso tra 32 e 64 caratteri.

   • Se creato, il segreto verrà incluso come parte di un hash, aggiunto alla richiesta HTTP come qlik-signature.

6. Evento cloud Il payload dell'evento emesso dal servizio Webhook di Qlik Cloud. Una volta abilitato e salvato, la modifica non può essere annullata.

7. Controlla revoca certificato quando abilitato verifica che i certificati del webhook siano validi e non revocati.

8. Facoltativamente, aggiungere le intestazioni HTTP da accodare alla richiesta. Selezionare la casella di controllo per crittografare il valore dell'intestazione

   Nota informaticaPer motivi di sicurezza non è possibile modificare le intestazioni crittografate; per eliminare l'intestazione, fare clic sull'icona di eliminazione. Per rimuovere il valore, fare clic sull'icona di rimozione e inserirne uno nuovo.

9. In Eventi, scegliere gli eventi di sistema che attiveranno il webhook. Gli eventi disponibili includono:

   • Eventi di automazione

   • Eventi API

   • Eventi dell'applicazione

   • Eventi di integrazione dei dati

   • Eventi utente

10. Fare clic su Crea.

Gestione dei webhook

Nota informatica

I webhook creati con Qlik Automate possono essere visualizzati solo nel centro attività Amministrazione. Non possono essere modificati, eliminati, abilitati o disabilitati.

Per gestire questi webhook, utilizzare l'interfaccia Qlik Automate.

Ordinamento e ricerca dei webhook

Per ordinare e cercare i webhook nella tabella:

• Fare clic su nella parte superiore di una colonna per modificare l'ordinamento.

• Fare clic su nella parte superiore di una colonna per cercare un webhook. Il filtro di ricerca funziona per corrispondenze complete e parziali.

Attivazione o disattivazione dei webhook

Procedere come indicato di seguito:

1. Nel centro attività Amministrazione, andare su Webhook.

2. Fare clic su accanto al webhook.

3. Per attivare il webhook, selezionare Abilita.

4. Per disattivare il webhook, selezionare Disabilita.

I webhook appena creati sono abilitati per impostazione predefinita.

Modifica dei webhook

Procedere come indicato di seguito:

1. Nel centro attività Amministrazione, andare su Webhook.

2. Per il webhook che si desidera modificare, fare clic su .

3. Selezionare Modifica.

4. Apportare le modifiche e fare clic su Salva.

Nota informaticaSe si fa clic su Annulla mentre ci sono modifiche non salvate, viene visualizzata una finestra di dialogo di conferma. Fare clic su Scarta per chiudere senza salvare le modifiche.

Eliminazione dei webhook

Procedere come indicato di seguito:

1. Nel centro attività Amministrazione, andare su Webhook.

2. Selezionare il webhook da eliminare.

3. Fare clic su Elimina.

4. Confermare l'eliminazione.

Nota informaticaIl pulsante Elimina non è disponibile finché non si seleziona uno o più webhook. La barra delle azioni visualizza il numero di webhook selezionati.

Visualizzazione della cronologia dei webhook

La cronologia degli eventi del webhook viene conservata per 7 giorni.

Procedere come indicato di seguito:

1. Nel centro attività Amministrazione, andare su Webhook.

2. Fare clic su accanto a un webhook per espanderne la cronologia degli eventi.

   

3. Per inviare nuovamente in modo manuale la consegna di un evento, fare clic su nella riga dell'evento.

4. Per visualizzare il payload della risposta all'evento, fare clic su nella riga dell'evento.

   Il payload mostra dettagli come l'ID dell'applicazione, il nome e il timestamp, utili per il debug o il controllo degli eventi passati.