Webhooks voor workflows maken en beheren

Hoe werken webhooks?

Wanneer er een gebeurtenis plaatsvindt in Qlik Cloud (bijvoorbeeld een nieuwe app wordt gemaakt of een gebruiker wordt verwijderd), stuurt een webhook informatie in de JSON-indeling naar een opgegeven externe applicatie met behulp van een HTTP-callback. Deze externe applicatie kan dan de gegevens van de gebeurtenis gebruiken om verdere acties te activeren.

Bijvoorbeeld:

• Breng uw team op de hoogte als er een nieuwe app is gemaakt.

• Er wordt automatisch een welkomstmail verzonden als er een nieuw teamlid wordt toegevoegd aan een tenant.

• Werk een spreadsheet bij als een gebruiker is verwijderd uit de tenant.

Voordelen van het gebruik van webhooks

Webhooks maken realtime integratie met andere systemen mogelijk, waardoor constante handmatige controles of herhalende API-aanvragen niet meer nodig zijn. Door te luisteren naar gebeurtenissen en de relevante gegevens onmiddellijk te verzenden, verminderen webhooks onnodig werk en maken ze een naadloze automatisering mogelijk.

Populaire platforms voor webhookintegraties

Om webhookgegevens te verwerken en erop te reageren, kunt u services op maat bouwen of platforms van derden gebruiken, zoals:

• Qlik Application Automation (alleen in het Engels)

• Pipedream

• Zapier

• Microsoft Power Automate

Beperkingen voor webhooks

Om de systeemprestaties te onderhouden en bronnen te beheren, zijn de volgende beperkingen van toepassing:

• De leveringsgeschiedenis van webhooks wordt 7 dagen bewaard.

• Elke gebruiker kan tot 150 webhooks bezitten.

• Er kunnen maximaal 100 webhooks per tenant worden gemaakt.

https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx

{
    "Content-Type": "application/json",
    "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
        }
    }
}

Webhooks maken

Webhooks kunnen worden gemaakt door:

• Tenantbeheerders vanuit het Beheer-activiteitencentrum.

• Alle gebruikers van de interface van Qlik Application Automation.

Voor meer informatie over het gebruik van webhooks met applicatie-automatisering, raadpleegt u Werken met webhooks (alleen in het Engels).

Doe het volgende:

1. In het Beheer-activiteitencentrum gaat u naar Webhooks.

2. Klik op Nieuw maken.

3. Voer een naam in voor de webhook en optioneel een beschrijving.

4. Voer voor URL (eindpunt) de volledig gekwalificeerde domeinnaam (FQDN) in waar de webhook JSON-gegevens naartoe zal sturen.

   • Deze URL moet het HTTPS-protocol gebruiken (voorbeeld: https: //domain.com). IP-adressen kunnen niet worden gebruikt als webhookeindpunten.

5. Voer optioneel een geheim voor webhook-verificatie in.

   • Het geheim moet tussen 32 en 64 tekens lang zijn.

   • Als het is aangemaakt, wordt het geheim opgenomen als onderdeel van een hash, die wordt toegevoegd aan de HTTP-aanvraag als een qlik-signature.

6. Voeg optioneel HTTP-kopteksten toe die aan de aanvraag worden toegevoegd.

7. Kies onder Gebeurtenissen de systeemgebeurtenissen die de webhook activeren. Beschikbare gebeurtenissen zijn:

   • App-gebeurtenissen: gemaakt, verwijderd, gegevens bijgewerkt (vernieuwd), gepubliceerd, opnieuw geladen.

   • Gebeurtenissen van gebruikers: gemaakt, verwijderd.

8. Klik op Maken.

Webhooks beheren

Webhooks sorteren en zoeken

Om webhooks in de tabel te sorteren en te doorzoeken, gaat u als volgt te werk:

• Klik op bovenaan een kolom om de sorteervolgorde te wijzigen.

• Klik op bovenaan een kolom om naar een webhook te zoeken. Het zoekfilter werkt voor volledige en voor gedeeltelijke matches.

Webhooks in- of uitschakelen

Doe het volgende:

1. In het Beheer-activiteitencentrum gaat u naar Webhooks.

2. Klik op naast de webhook.

3. Als u de webhook wilt inschakelen, selecteert u Webhook inschakelen.

4. Als u de webhook wilt inschakelen, selecteert u Webhook uitschakelen.

Nieuwe webhooks worden standaard ingeschakeld.

Webhooks bewerken

Doe het volgende:

1. In het Beheer-activiteitencentrum gaat u naar Webhooks.

2. Klik op van de webhook die u wilt bewerken.

3. Selecteer Bewerken.

4. Voer de bewerkingen uit en klik op Opslaan.

Webhooks verwijderen

Doe het volgende:

1. In het Beheer-activiteitencentrum gaat u naar Webhooks.

2. Selecteer de webhook die u wilt verwijderen.

3. Klik op Verwijderen.

4. Bevestig de verwijdering.

De geschiedenis van webhooks bekijken

De gebeurtenisgeschiedenis van webhooks wordt 7 dagen bewaard.

Doe het volgende:

1. In het Beheer-activiteitencentrum gaat u naar Webhooks.

2. Klik op naast een webhook om de gebeurtenisgeschiedenis uit te breiden.

   

3. Als u een gebeurtenisverzending handmatig opnieuw wilt verzenden, klik dan op aan het einde van de rij voor gebeurtenissen.

4. Als u de nettolading van de reactie van de gebeurtenis wilt bekijken, klikt u op aan het einde van de rij voor gebeurtenissen.

   De nettolading toont details zoals app-id, naam en tijdstempel, wat handig is voor het opsporen van fouten of het controleren van gebeurtenissen uit het verleden.