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.
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.
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.
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.
Gör följande:
-
I Hanteringskonsol går du till Webhooks.
-
Klicka på Skapa ny längst upp till höger.
-
I dialogrutan Skapa webhook anger du ett namn för webhooken.
-
Lägg till en beskrivning (valfritt).
-
Ange URL:en för integreringsprogrammet från tredje part.
-
Ange en hemlighet som ska läggas till i HTTP-förfrågan (valfritt).
-
Lägg till HTTP-rubriker som ska läggas till i förfrågan (valfritt).
-
Under Händelser väljer du händelsetyp för webhooken.
-
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.
Redigera en webhook
Gör följande:
-
I Hanteringskonsol går du till Webhooks.
-
Klicka på knappen i slutet av raden för den webhook du vill redigera.
-
Klicka på Redigera.
Redigeringspanelen visas med alternativ för att ändra webhookens konfiguration.
-
Gör dina ändringar och klicka på Spara.
Ta bort en webhook
Gör följande:
-
I Hanteringskonsol går du till Webhooks.
-
Välj den webhook som ska tas bort.
-
Klicka på Ta bort längst upp till höger.
-
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.
-
Om du vill visa webhook-historiken klickar du på knappen i slutet av webhook-raden.
Webhook-historiken visas.
-
Om du vill skicka en händelseleverans igen manuellt klickar du på knappen i slutet av händelseraden.
-
Om du vill visa händelsesvarets nyttolast klickar du på knappen i slutet av händelseraden.