Skapa och hantera webhooks för arbetsflöden

Nödvändiga behörigheter för webhooks

När du skapar eller hanterar webhooks med hjälp av Qlik Cloud Webhooks API och gränssnittet för automatiseringar måste du begära en eller båda av dessa behörigheter:

• Använd webhooks: Krävs för att skapa, visa, uppdatera och ta bort webhooks som ägs av användaren.

• Hantera webhooks: Krävs för att hantera alla webhooks i klientorganisationen, inklusive de som skapats av andra användare.

Så fungerar webhooks

När en händelse inträffar i Qlik Cloud (till exempel att en ny applikation skapas eller en användare tas bort) skickar en webhook information i JSON-format till en angiven extern applikation med hjälp av ett HTTP-återanrop. Denna externa applikation kan sedan använda händelsedata för att utlösa ytterligare åtgärder.

Till exempel:

• Meddela ditt team via Slack när en ny applikation skapas.

• Skicka automatiskt ett välkomstmejl när en ny teammedlem 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 realtidsintegration med andra system, vilket eliminerar behovet av ständiga manuella kontroller eller repetitiva API-begäranden. Genom att lyssna efter händelser och skicka relevanta data omedelbart minskar webhooks onödigt arbete och möjliggör smidig automatisering.

Populära plattformar för webhook-integrationer

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

• Qlik Automate (endast på engelska)

• 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
        }
    }
}

Skapa webhooks

Webhooks kan skapas av:

• Klientorganisationsadministratörer från aktivitetscentret Administration.

• Alla användare från gränssnittet Qlik Automate.

För mer information om att använda webhooks med Qlik Automate, se Arbeta med webhooks (endast på engelska).

Gör följande:

1. I aktivitetscentret Administration går du till Webhooks.

2. Klicka på Skapa ny.

3. Ange ett namn för webhooken och lägg eventuellt till en beskrivning.

4. För URL (slutpunkt) anger du det fullständiga domännamnet (FQDN) dit webhooken ska skicka JSON-data.

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

5. Ange eventuellt 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 bifogas till HTTP-begäran som en qlik-signature.

6. Molnhändelse Händelsenyttolasten som skickas av tjänsten Qlik Cloud Webhooks. När den har aktiverats och sparats kan ändringen inte ångras.

7. Kontrollera certifikatåterkallelse när det är aktiverat verifierar att webhook-certifikaten är giltiga och inte har återkallats.

8. Lägg eventuellt till HTTP-huvuden som ska bifogas till begäran. Markera kryssrutan för att kryptera huvudvärdet

   Anteckning om informationAv säkerhetsskäl kan du inte redigera krypterade huvuden. För att ta bort huvudet klickar du på raderingsikonen. För att ta bort värdet klickar du på borttagningsikonen och anger ett nytt.

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

   • Automatisering-händelser

   • API-händelser

   • Applikation-händelser

   • Dataintegration-händelser

   • Användarhändelser

10. Klicka på Skapa.

Hantera webhooks

Anteckning om information

Webhooks som skapats med Qlik Automate kan endast visas i aktivitetscentret Administration. De kan inte redigeras, tas bort, aktiveras eller inaktiveras.

För att hantera dessa webhooks använder du gränssnittet Qlik Automate.

Sortera och söka efter webhooks

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

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

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

Slå på eller stänga av webhooks

Gör följande:

1. I aktivitetscentret Administration går du till Webhooks.

2. Klicka på bredvid webhooken.

3. För att slå på webhooken väljer du Aktivera.

4. För att stänga av webhooken väljer du Inaktivera.

Nyskapade webhooks är aktiverade som standard.

Redigera webhooks

Gör följande:

1. I aktivitetscentret Administration går du till Webhooks.

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

3. Välj Redigera.

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

Anteckning om informationOm du klickar på Avbryt när det finns osparade ändringar visas en bekräftelsedialogruta. Klicka på Kassera för att stänga utan att spara dina ändringar.

Ta bort webhooks

Gör följande:

1. I aktivitetscentret Administration går du till Webhooks.

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

3. Klicka på Ta bort.

4. Bekräfta borttagningen.

Anteckning om informationKnappen Ta bort är inte tillgänglig förrän du väljer en eller flera webhooks. Åtgärdsfältet visar antalet valda webhooks.

Visa webhook-historik

Händelsehistorik för webhooks sparas i 7 dagar.

Gör följande:

1. I aktivitetscentret Administration går du till Webhooks.

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

   

3. För att manuellt skicka om en händelseleverans klickar du på på händelseraden.

4. För att visa händelsens svarsnyttolast klickar du på på händelseraden.

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