Skapa och hantera webhooks för arbetsflöden

Hur webhooks fungerar

När en händelse inträffar i Qlik Cloud (t.ex. en ny app har skapats eller en användare har tagits bort) skickar en webhook information i JSON-format till en angiven extern applikation med hjälp av ett HTTP-anrop. Detta externa program kan då använda händelsedata för att utlösa ytterligare åtgärder.

Exempel:

• Meddela ditt team arbetsgrupp via Slack varje gång en ny app skapas.

• Skicka automatiskt ett välkomstmeddelande varje gång nya teammedlemmar läggs till i en klientorganisation.

• Uppdatera ett kalkylblad när en användare tas bort från klientorganisationen.

Fördelar med att använda webhooks

Webhooks möjliggör integrering med andra system i realtid, vilket eliminerar behovet av ständiga manuella kontroller eller upprepade förfrågningar om API. Genom att lyssna efter händelser och omedelbart skicka relevanta data minskar webhooks onödigt arbete och möjliggör smidig automatisering.

Populära plattformar för integrering av webhooks

För att hantera och svara på webhook-data kan du bygga anpassade tjänster eller använda tredjepartsplattformar som:

• Qlik programautomatisering (endast på engelska)

• Pipedream

• Zapier

• Microsoft Power Automate

Gränser för Webhook

För att bibehålla systemprestanda och hantera resurser gäller följande gränser:

• Webhooks leveranshistorik sparas under en period av 7 dagar.

• Varje användare kan äga max 150 webhooks.

• Maximum 100 webhooks kan skapas per klientorganisation.

https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx

{
    "Content-Type": "application/json",
    "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
        }
    }
}

Skapa webhooks

Webhooks kan skapas av:

• Klientorganisationsadministratörer via aktivitetscenter för Administration.

• Alla användare från Qlik-gränssnittet för programautomatisering.

Se Arbeta med webhooks (endast på engelska) för mer information om hur du använder Webhooks med programautomatisering.

Gör följande:

1. Gå till Webhooks i aktivitetscentret för Administration.

2. Klicka på Skapa ny.

3. Skriv in ett namn på webhooken, och eventuellt en beskrivning.

4. Ange det fullständigt kvalificerade domännamnet (FQDN) dit webhooken kommer att skicka JSON-data för URL(-slutpunkt).

   • Denna URL måste använda HTTPS-protokollet (Exempel: https: //domain.com). IP-adresser kan inte användas som webhook-slutpunkter.

5. Du kan skriva in en hemlighet för webhook-autentisering.

   • Hemligheten måste vara mellan 32 och 64 tecken.

   • Om den skapas kommer hemligheten att inkluderas som en del av en hash, som läggs till HTTP-begäran som en qlik-signature.

6. Lägg till HTTP-rubriker som ska läggas till i förfrågan (valfritt).

7. Under Händelser väljer du de systemhändelser som ska utlösa webhooken. Tillgängliga händelser inkluderar:

   • Apphändelser: skapad, borttagen, exporterad, data uppdaterad, publicerad, laddad

   • Användarhändelser: skapad, borttagen.

8. Klicka på Skapa.

Hantera webhooks

Sortera och söka webhooks

För att sortera och söka webhooks i tabellen:

• Klicka på längst upp i en kolumn för att ändra sorteringsordningen.

• Klicka på längst upp i en kolumn för att söka efter en webhook. Sökfiltret fungerar för fullständiga och delvisa matchningar.

Aktivering eller inaktivering av webhooks

Gör följande:

1. Gå till Webhooks i aktivitetscentret för Administration.

2. Klicka på bredvid en webhook.

3. För att aktivera en webhook, välj Aktivera webhook.

4. För att inaktivera en webhook, välj Inaktivera webhook.

Nyskapade webhooks är aktiverade som standard.

Redigera en webhook

Gör följande:

1. Gå till Webhooks i aktivitetscentret för Administration.

2. För den webhook du vill redigera klickar du på .

3. Välj Redigera.

4. Gör dina ändringar och klicka på Spara.

Ta bort en webhook

Gör följande:

1. Gå till Webhooks i aktivitetscentret för Administration.

2. Välj den webhook som ska tas bort.

3. Klicka på Radera.

4. Bekräfta borttagningen.

Visa webhook-historik

Webhook-händelsehistorik sparas under en period av 7 dagar.

Gör följande:

1. Gå till Webhooks i aktivitetscentret för Administration.

2. Klicka på bredvid en webhook för att expandera dess händelsehistorik.

   

3. Klicka på på händelseraden för att manuellt skicka en händelseleverans igen.

4. Klicka på på händelseraden för att visa händelsesvarets nyttolast.

   Nyttolasten visar detaljer som App-ID, namn och tidsstämpel, vilket är användbart för felsökning eller granskning av tidigare händelser.