Skapa och hantera webhooks för arbetsflöden

Webhooksbehörigheter som krävs

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

• Använda 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.

Hur webhooks fungerar

När en händelse inträffar i Qlik Cloud (till exempel skapas en ny applikation eller en användare tas 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 via Slack när en ny applikation 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 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 via aktivitetscenter för Administration.

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

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

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. Molnhändelse Händelsenyttolasten som skickas av Qlik Cloud Webhooks-tjänsten. När den har aktiverats och sparats kan ändringen inte ångras.

7. Kontrollera återkallning av certifikat kontrollerar, när den är aktiverad, att webhook-certifikaten är giltiga och inte har återkallats.

8. Lägg till HTTP-rubriker som ska läggas till i förfrågan (valfritt). Markera kryssrutan för att kryptera rubrikvärdet

   Anteckning om informationAv säkerhetsskäl kan du inte redigera krypterade rubriker. För att ta bort rubriken, klicka på borttagningsikonen. För att ta bort värdet, klicka på borttagningsikonen och ange ett nytt.

9. Under Händelser väljer du de systemhändelser som ska utlösa webhooken. För att filtrera en händelse, se Lägga till filter för händelser.

   Tillgängliga händelser inkluderar:

   • Automationshändelser

   • API-händelser

   • Applikationshändelser

   • Dataintegreringshändelser

   • Användarhändelser

10. Klicka på Skapa.

Lägga till filter för händelser

Du kan lägga till ett filter när du skapar eller redigerar en webhook. Ett filter skickar endast data när den valda händelsen matchar filtervillkoren.

En filterikon visas bredvid en händelsekategori när en händelse i den kategorin har ett filter.

Gör följande:

1. I delavsnittet Händelser väljer du en händelse som stöder filtrering. Knappen Lägg till filter visas när du väljer en händelse som stöds.

2. Klicka på Lägg till filter.

   Anteckning om informationEn webhook med ett filter kan endast ha en händelse vald. Att lägga till ett filter inaktiverar alla andra valda händelser. Om du redan har valt andra händelser informerar en bekräftelsedialogruta dig om att de kommer att avmarkeras.

3. I filterbyggaren väljer du ett fält, en operator och ett värde.

   • Tillgängliga fält beror på den valda händelsen.

   • Den tillgängliga värdekontrollen beror på det valda fältet. Du kan välja ett listat värde, söka efter en resurs eller ange ett värde manuellt.

4. För att lägga till ett villkor i gruppen klickar du på Lägg till villkor. Välj och eller eller för att definiera hur villkoren kombineras.

5. För att lägga till en villkorsgrupp klickar du på Lägg till grupp. Välj och eller eller för att definiera hur grupperna kombineras.

6. Granska förhandsgranskningen av Filteruttryck.

   Anteckning om informationFilteruttrycket visas för felsökning och validering och kan inte redigeras. För att ändra filtret använder du filterbyggaren. Ett filteruttryck kan innehålla upp till 512 tecken.

7. Skapa eller spara webhooken.

Exempel

För att ta emot händelser endast när en omladdning slutförs utan fel skapar du ett filter för händelsen Reload Task Completed. Det resulterande filteruttrycket är: data.status eq "SUCCEEDED"

Händelser som inte stöder filtrering

Filtrering stöds inte för följande händelser:

• Appdatamodell uppdaterad
• API-nyckelvalidering misslyckades
• Automatisering skapad
• Automatisering togs bort
• Automatisering uppdaterad
• Användare skapad
• Användare borttagen

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änd gränssnittet Qlik Automate.

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.

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

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.

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

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.

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

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 applikations-ID, namn och tidsmarkör, vilket är användbart för felsökning eller granskning av tidigare händelser.