Webhooks voor workflows maken en beheren

Vereiste webhook-machtigingen

Bij het maken of beheren van webhooks met behulp van de Qlik Cloud Webhooks API en de gebruikersinterface voor automatiseringen, moet u een of beide van deze machtigingen aanvragen:

• Webhooks gebruiken: Vereist om webhooks te maken, bekijken, bijwerken en verwijderen die eigendom zijn van de gebruiker.

• Webhooks beheren: Vereist om alle webhooks in de tenant te beheren, inclusief webhooks die door andere gebruikers zijn gemaakt.

Hoe webhooks werken

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

Bijvoorbeeld:

• Breng uw team op de hoogte via Slack wanneer een nieuwe applicatie wordt gemaakt.

• Stuur automatisch een welkomst-e-mail wanneer een nieuw teamlid wordt toegevoegd aan een tenant.

• Werk een spreadsheet bij wanneer een gebruiker uit de tenant wordt verwijderd.

Voordelen van het gebruik van webhooks

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

Populaire platforms voor webhook-integraties

Om webhook-gegevens te verwerken en erop te reageren, kunt u aangepaste services bouwen of platforms van derden gebruiken, zoals:

• Qlik Automate (alleen in het Engels)

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

Webhooks maken

Webhooks kunnen worden gemaakt door:

• Tenant-beheerders vanuit het activiteitencentrum Beheer.

• Alle gebruikers vanuit de Qlik Automate-interface.

Zie Werken met webhooks (alleen in het Engels) voor meer informatie over het gebruik van webhooks met Qlik Automate.

Doe het volgende:

1. Ga in het activiteitencentrum Beheer naar Webhooks.

2. Klik op Nieuwe maken.

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

4. Voer voor URL (eindpunt) de volledig gekwalificeerde domeinnaam (FQDN) in waarnaar de webhook JSON-gegevens zal verzenden.

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

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

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

   • Indien gemaakt, wordt het geheim opgenomen als onderdeel van een hash, toegevoegd aan het HTTP-verzoek als een qlik-signature.

6. Cloud-gebeurtenis De gebeurtenispayload die wordt uitgezonden door de Qlik Cloud Webhooks-service. Eenmaal ingeschakeld en opgeslagen, kan de wijziging niet ongedaan worden gemaakt.

7. Certificaatintrekking controleren verifieert, indien ingeschakeld, dat de webhook-certificaten geldig zijn en niet zijn ingetrokken.

8. Voeg optioneel HTTP-headers toe om aan het verzoek toe te voegen. Schakel het selectievakje in om de headerwaarde te versleutelen

   InformatieOm veiligheidsredenen kunt u versleutelde headers niet bewerken. Klik op het verwijderpictogram om de header te verwijderen. Om de waarde te verwijderen, klikt u op het verwijderpictogram en voert u een nieuwe in.

9. Kies onder Gebeurtenissen de systeemgebeurtenissen die de webhook zullen activeren. Beschikbare gebeurtenissen zijn onder meer:

   • Automatisering-gebeurtenissen

   • API-gebeurtenissen

   • Applicatie-gebeurtenissen

   • Gegevensintegratie-gebeurtenissen

   • Gebruikersgebeurtenissen

10. Klik op Maken.

Webhooks beheren

Informatie

Webhooks die zijn gemaakt met Qlik Automate kunnen alleen worden bekeken in het activiteitencentrum Beheer. Ze kunnen niet worden bewerkt, verwijderd, ingeschakeld of uitgeschakeld.

Gebruik de Qlik Automate-interface om deze webhooks te beheren.

Webhooks sorteren en zoeken

Om webhooks in de tabel te sorteren en te zoeken:

• 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 gedeeltelijke overeenkomsten.

Webhooks in- of uitschakelen

Doe het volgende:

1. Ga in het activiteitencentrum Beheer naar Webhooks.

2. Klik op naast de webhook.

3. Selecteer Inschakelen om de webhook in te schakelen.

4. Selecteer Uitschakelen om de webhook uit te schakelen.

Nieuw gemaakte webhooks zijn standaard ingeschakeld.

Webhooks bewerken

Doe het volgende:

1. Ga in het activiteitencentrum Beheer naar Webhooks.

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

3. Selecteer Bewerken.

4. Breng uw bewerkingen aan en klik op Opslaan.

InformatieAls u op Annuleren klikt terwijl er niet-opgeslagen wijzigingen zijn, verschijnt er een bevestigingsvenster. Klik op Verwerpen om te sluiten zonder uw wijzigingen op te slaan.

Webhooks verwijderen

Doe het volgende:

1. Ga in het activiteitencentrum Beheer naar Webhooks.

2. Selecteer de webhook die u wilt verwijderen.

3. Klik op Verwijderen.

4. Bevestig de verwijdering.

InformatieDe knop Verwijderen is niet beschikbaar totdat u een of meer webhooks selecteert. De actiebalk geeft het aantal geselecteerde webhooks weer.

Webhook-geschiedenis bekijken

De geschiedenis van webhook-gebeurtenissen wordt 7 dagen bewaard.

Doe het volgende:

1. Ga in het activiteitencentrum Beheer naar Webhooks.

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

   

3. Om een gebeurtenislevering handmatig opnieuw te verzenden, klikt u op in de gebeurtenisrij.

4. Om de payload van de gebeurtenisreactie te bekijken, klikt u op in de gebeurtenisrij.

   De payload toont details zoals applicatie-ID, naam en tijdstempel, wat handig is voor het debuggen of controleren van eerdere gebeurtenissen.