Webhooks maken voor werkstromen
Met behulp van webhooks kunt u Qlik Cloud-systeemgebeurtenissen gebruiken voor het activeren van uw werkstromen. Zodra u een webhook maakt, wordt er automatisch een JSON-aanvraag naar het webhook-eindpunt verzonden telkens als de gedefinieerde systeemgebeurtenis plaatsvindt. U kunt webhooks gebruiken om gebeurtenisgegevens te versturen naar applicaties die JSON-gegevens kunnen ontvangen.
Als uw tenant de nieuwe navigatie-ervaring gebruikt, vervangt het Beheer activiteitencentrum de Beheerconsole.
Ga voor meer informatie naar Nieuwe platformnavigatie.
Eigenschappen van webhooks
Als u een webhook wilt maken, moet u de eigenschappen van de webhook en het eindpunt definiëren en de gebeurtenistypen voor Qlik Cloud kiezen.
Eigenschap | Beschrijving |
---|---|
Naam | Naam van de webhook. |
Beschrijving (optioneel) | Beschrijving van de webhook. |
URL | URL voor het webhook-eindpunt. De URL (webhook-eindpunt) moet een volledig gekwalificeerde domeinnaam (Fully Qualified Domain Name, FDQN) zijn en gebruik maken van het HTTPS-protocol. Het eindpunt mag geen IP-adres zijn. |
Geheim (optioneel) | Geheim voor webhook-verificatie. Het geheim moet minimaal 32 tekens en maximaal 64 tekens lang zijn. Een geheime webhook maakt deel uit van een hash die als een qlik-signature wordt toegevoegd aan de HTTP-aanvraag. |
Headers (optioneel) |
Kopteksten die kunnen worden toegevoegd aan de HTTP-aanvraag. |
Elke webhook is geconfigureerd met één of meer gebeurtenistypen.
Bron | Gebeurtenistypen |
---|---|
Apps | Gemaakt, Verwijderd, Gegevens bijgewerkt, Geladen, Gepubliceerd, Geëxporteerd InformatieBij de gebeurtenis gegevensupdate worden er gegevens ververst. Bij de gebeurtenis opnieuw laden wordt de Qlik Sense-app met de bijbehorende gegevenstabellen opnieuw geladen. |
Gebruikers | Gemaakt, Verwijderd |
De webhook wacht todat één van deze gebeurtenissen voorkomt. Zodra dit het geval is, worden de gebeurtenisgegevens naar het webhook-eindpunt verzonden. De gegevens worden doorgegeven aan de eindpunt-URL als een JSON-aanvraag.
Voorbeeld: JSON-aanvraag voor het gebeurtenistype App verwijderd
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
}
}
}
Een webhook maken
U kunt vanuit de Beheerconsole webhooks maken. U kunt ook webhooks maken via de interface van Qlik automatisering van toepassingen. Ga voor meer informatie naar Werken met webhooks (alleen in het Engels).
U kunt maximaal 100 webhooks maken voor elke tenant.
Doe het volgende:
-
Ga in de Beheerconsole naar Webhooks.
-
Klik in de rechterbovenhoek op Nieuwe Maken.
-
Voer in het dialoogvenster Webhook maken een naam voor de webhook in.
-
Voeg een optionele beschrijving toe.
-
Voer de URL in voor de integratietoepassing van derden.
-
Voer eventueel het geheim in dat aan de HTTP-aanvraag wordt toegevoegd.
-
Voeg optioneel HTTP-headers toe die aan de aanvraag worden toegevoegd.
-
Selecteer de gebeurtenistypen voor de webhook onder Gebeurtenissen.
-
Als u hiermee klaar bent, klikt u op Maken.
De webhooks worden weergegeven in een tabel. Nieuwe webhooks worden standaard ingeschakeld.
Een webhook bewerken
Doe het volgende:
-
Ga in de Beheerconsole naar Webhooks.
-
Klik op de knop onderaan de rij van de webhook die u wilt bewerken.
-
Klik op Bewerken.
Het bewerkingsvenster wordt weergegeven met opties om de configuratie van de webhook te wijzigen.
-
Voer de bewerkingen uit en klik op Opslaan.
Een webhook verwijderen
Doe het volgende:
-
Ga in de Beheerconsole naar Webhooks.
-
Selecteer de webhook die u wilt verwijderen.
-
Klik in de rechter bovenhoek op Verwijderen.
-
Er verschijnt een pop-updialoogvenster ter bevestiging van de selectie. Klik op Verwijderen.
De geschiedenis van webhooks bekijken
U kunt de webhookgeschiedenis bekijken via Webhooks in de Beheerconsole.
-
Klik op de knop aan het einde van de rij voor webhooks om de webhookgeschiedenis te verwijderen.
De webhookgeschiedenis wordt weergegeven.
-
Als u een gebeurtenisverzending handmatig opnieuw wilt verzenden, klik dan op de knop aan het einde van de rij voor gebeurtenissen.
-
Als u de nettolading van de reactie van de gebeurtenis wilt bekijken, klikt u op de knop aan het einde van de rij voor gebeurtenissen.