Gå till huvudinnehåll Gå till ytterligare innehåll

Skapa webhooks för arbetsflöden

Med webhooks kan du använda Qlik Cloud-systemhändelser som utlösare i ditt arbetsflöde. När du har skapat en webhook skickar den automatiskt en JSON-förfrågan till webhook-slutpunkten varje gång den definierade systemhändelsen inträffar. Du kan använda webhooks för att skicka händelsedata till program som kan ta emot JSON-data.

Webhook-egenskaper

När du skapar en webhook måste du konfigurera egenskaper för webhooken och slutpunkten, och välja Qlik Cloud-händelsetyperna.

Webhook-egenskaper
Egenskap Beskrivning
Namn Webhookens namn.
Beskrivning (valfritt) Beskrivning av webhooken.
URL URL för webhookens slutpunkt. URL:en (webhookens slutpunkt) måste vara ett fullt kvalificerat domännamn (FDQN) och använda HTTPS-protokoll. Slutpunkten kan inte vara en IP-adress.
Hemlighet (valfritt) Hemlighet för webhook-autentisering. Hemligheten måste bestå av minst 32 och högst 64 tecken. Om du skapar en webhook-hemlighet är den en del av en hash som läggs till i HTTP-förfrågan som en qlik-signature.
Rubriker (valfritt)

Rubriker som kan läggas till i HTTP-förfrågan.

Varje webhook konfigureras med minst en händelsetyp.

Händelsetyper för webhooks
Resurs Händelsetyper
Appar Skapas, Tas bort, Data uppdateras, Laddas, Publiceras, Exporteras
Anteckning om informationEn datauppdateringshändelse avser att data uppdateras. En omladdningshändelse avser att Qlik Sense-appen och associerade datatabeller laddas.
Användare Skapas, Tas bort

Webhooken väntar på att någon av händelserna ska inträffa, och när det sker skickar den händelsedata till webhook-slutpunkten. Data skickas till slutpunktens URL som en JSON-förfrågan.

Anteckning om informationMer information om händelsenyttolaster finns i Portal för Qlik-utvecklare: API-händelser.

Exempel: JSON-förfrågan för händelsetypen App tas bort

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

Skapa en webhook

Du skapar webhooks från Hanteringskonsol. Du kan också skapa webhooks från Qlik Application Automation-gränssnittet. Mer information finns i Arbeta med webhooks (endast på engelska).

Du kan skapa högst 100 webhooks för varje klientorganisation.

  1. I Hanteringskonsol går du till Webhooks.

  2. Klicka på Skapa ny längst upp till höger.

  3. I dialogrutan Skapa webhook anger du ett namn för webhooken.

  4. Lägg till en beskrivning (valfritt).

  5. Ange URL:en för integreringsprogrammet från tredje part.

  6. Ange en hemlighet som ska läggas till i HTTP-förfrågan (valfritt).

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

  8. Under Händelser väljer du händelsetyp för webhooken.

  9. När du är klar klickar du på Skapa.

    Alla webhooks listas i en tabell. När nya webhooks skapas är de aktiverade som standard.

Webhooks-tabell i Hanteringskonsol
Anteckning om tipsDu kan aktivera eller stänga av en webhook genom att klicka på knappen Ikon i användargränssnittet med tre punkter som öppnar alternativmenyn för en webhook i slutet av webhook-raden, och välja Aktivera webhook eller Inaktivera webhook. Webhooks är aktiverade som standard.
Anteckning om tipsDu kan sortera och söka efter webhooks i tabellen. Ändra sorteringsordningen genom att klicka på ikonen Ikon med uppåt-/nedåtpil för sortering av kolumnvärdena längst upp i någon av kolumnerna, och om du vill söka efter en webhook manuellt klickar du på filterikonen Filterikon längst upp i varje webhook-kolumn längst upp i en kolumn. Sökfiltret fungerar för både fullständiga och delvisa matchningar.

Redigera en webhook

  1. I Hanteringskonsol går du till Webhooks.

  2. Klicka på knappen Ikon i användargränssnittet med tre punkter som öppnar alternativmenyn för en webhook i slutet av raden för den webhook du vill redigera.

  3. Klicka på Redigera.

    Redigeringspanelen visas med alternativ för att ändra webhookens konfiguration.

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

Ta bort en webhook

  1. I Hanteringskonsol går du till Webhooks.

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

  3. Klicka på Ta bort längst upp till höger.

  4. En popup-dialog öppnas där du bekräftar ditt val. Klicka på Ta bort.

Visa webhook-historik

Du kommer åt webhook-historiken under Webhooks i Hanteringskonsol.

Anteckning om informationHändelseleveranser tas bort från webhook-historiken efter sju dagar.
  • Om du vill visa webhook-historiken klickar du på knappen Ikon i användargränssnittet med nedpil för att visa webhook-menyn i slutet av webhook-raden.

    Webhook-historiken visas.

    Webhook-historik i Hanteringskonsol

  • Om du vill skicka en händelseleverans igen manuellt klickar du på knappen Ikon för omsändning som används för att skicka om en webhook i slutet av händelseraden.

  • Om du vill visa händelsesvarets nyttolast klickar du på knappen Ikon i användargränssnittet med nedpil för att visa menyn med händelsens nyttolast i slutet av händelseraden.

    Nyttolastinformation för webhook-händelsetypen i Hanteringskonsol

Mer information

Var den här sidan till hjälp för dig?

Om du hittar några fel på denna sida eller i innehållet – ett stavfel, ett steg som saknas eller ett tekniskt fel – berätta för oss så att vi kan blir bättre!