Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Erstellen von Webhooks für Workflows

Webhooks bieten eine Möglichkeit, Qlik Cloud Systemereignisse als Auslöser in Ihren Workflows zu verwenden. Nachdem Sie einen Webhook erstellt haben, sendet dieser automatisch eine JSON-Anforderung an den Webhook-Endpunkt, wenn das definierte Systemereignis eintritt. Sie können Webhooks verwenden, um Ereignisdaten an eine beliebige Anwendung zu senden, die JSON-Daten empfangen kann.

Webhook-Eigenschaften

Um einen Webhook zu erstellen, müssen Sie den Webhook und die Endpunkt-Eigenschaften konfigurieren und die Qlik Cloud Ereignistypen auswählen.

Webhook-Eigenschaften
Eigenschaft Beschreibung
Name Name des Webhooks.
Beschreibung (optional) Beschreibung des Webhooks.
URL URL für den Webhook-Endpunkt. Die URL (Webhook-Endpunkt) muss ein vollqualifizierter Domänenname (FDQN) sein und das HTTPS-Protokoll verwenden. Der Endpunkt kann keine IP-Adresse sein.
Geheimer Schlüssel (optional) Schlüssel für die Webhook-Authentifizierung. Der geheime Schlüssel muss mindestens 32 Zeichen und maximal 64 Zeichen lang sein. Wenn Sie einen geheimen Webhook-Schlüssel erstellen, ist er Teil eines Hashs, der an die HTTP-Anforderung als qlik-signature angehängt wird.
Header (optional)

Header, die an die HTTP-Anforderung angehängt werden können.

Jeder Webhook wird mit einem oder mehreren Ereignistypen konfiguriert.

Ereignistypen für Webhooks
Ressource Ereignistypen
Apps Erstellt, Gelöscht, Daten aktualisiert, Geladen, Veröffentlicht, Exportiert
InformationshinweisEin Datenaktualisierungsereignis bezieht sich auf Daten, die aktualisiert werden. Ein Ladeereignis bezieht sich auf die Qlik Sense App und zugehörige Datentabellen, die geladen werden.
Benutzer Erstellt, Gelöscht

Der Webhook wartet, bis eines der Ereignisse eintritt. Dann sendet er die Ereignisdaten an den Webhook-Endpunkt. Die Daten werden an die Endpunkt-URL als JSON-Anforderung übergeben.

InformationshinweisWeitere Informationen über die Ereignisnutzlasten finden Sie unter Qlik Developer Portal: API-Ereignisse.

Beispiel: JSON-Anforderung für den Ereignistyp „App gelöscht“

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

Erstellen eines Webhooks

Webhooks werden über die Verwaltungskonsole erstellt. Sie können auch Webhooks über die Benutzeroberfläche der Qlik-Anwendungsautomatisierung erstellen. Weitere Informationen finden Sie unter Arbeiten mit Webhooks (nur auf Englisch).

Pro Mandant können Sie maximal 100 Webhooks erstellen.

  1. Gehen Sie in der Verwaltungskonsole zu Webhooks.

  2. Klicken Sie in der oberen rechten Ecke auf Neu erstellen.

  3. Geben Sie im Dialogfeld Webhook erstellen einen Namen für den Webhook ein.

  4. Fügen Sie eine optionale Beschreibung hinzu.

  5. Geben Sie die URL für die Drittanbieter-Integrationsanwendung ein.

  6. Geben Sie optional den Schlüssel ein, um diesen an die HTTP-Anforderung anzuhängen.

  7. Fügen Sie optional HTTP-Header zum Anhängen an die Anforderung hinzu.

  8. Wählen Sie unter Ereignisse den Ereignistyp für den Webhook aus.

  9. Wenn Sie fertig sind, klicken Sie auf Erstellen.

    Die Webhooks werden in einer Tabelle aufgelistet. Neu erstellte Webhooks sind standardmäßig aktiviert.

Webhooks-Tabelle in der Verwaltungskonsole
TipphinweisSie können einen Webhook aktivieren oder deaktivieren, indem Sie auf die Schaltfläche Drei-Punkte-Symbol der Benutzeroberfläche zum Öffnen des Menüs „Optionen“ für den Webhook am Ende der Webhook-Zeile klicken und Webhook aktivieren bzw. Webhook deaktivieren auswählen. Webhooks sind standardmäßig aktiviert.
TipphinweisSie können Webhooks in der Tabelle sortieren und durchsuchen, indem Sie auf das Symbol Symbol Pfeil nach oben/unten zum Sortieren der Spaltenwerte oben in einer beliebigen Spalte klicken, um die Sortierreihenfolge zu ändern, oder indem Sie auf das Filtersymbol Filtersymbol oben in jeder Webhook-Spalte oben in jeder Spalte klicken, um manuell nach einem Webhook zu suchen. Der Suchfilter funktioniert sowohl für vollständige als auch für teilweise Übereinstimmungen.

Bearbeiten eines Webhooks

  1. Gehen Sie in der Verwaltungskonsole zu Webhooks.

  2. Klicken Sie für den Webhook, den Sie bearbeiten möchten, auf die Schaltfläche Drei-Punkte-Symbol der Benutzeroberfläche zum Öffnen des Menüs „Optionen“ für den Webhook am Ende der Zeile.

  3. Klicken Sie auf Bearbeiten.

    Das Bearbeitungsfenster wird mit Optionen angezeigt, mit denen Sie die Webhook-Konfiguration ändern können.

  4. Nehmen Sie Ihre Bearbeitungen vor und klicken Sie auf Speichern.

Löschen eines Webhooks

  1. Gehen Sie in der Verwaltungskonsole zu Webhooks.

  2. Wählen Sie den zu löschenden Webhook aus.

  3. Klicken Sie in der oberen rechten Ecke auf Löschen.

  4. Es wird ein Popup-Fenster geöffnet, in dem Sie Ihre Auswahl bestätigen können. Klicken Sie auf Löschen.

Anzeigen des Webhook-Verlaufs

Den Webhook-Verlauf finden Sie unter Webhooks in der Verwaltungskonsole.

InformationshinweisEreigniszustellungen werden nach 7 Tagen aus dem Webhook-Verlauf gelöscht.
  • Um den Webhook-Verlauf anzuzeigen, klicken Sie auf die Schaltfläche Pfeil-nach-unten-Symbol der Benutzeroberfläche zum Erweitern des Webhook-Menüs am Ende der Webhook-Zeile.

    Der Webhook-Verlauf wird angezeigt.

    Webhooks-Tabelle in der Verwaltungskonsole

  • Um eine Ereigniszustellung manuell erneut zu senden, klicken Sie auf die Schaltfläche Erneut-senden-Symbol zum erneuten Senden des Webhooks am Ende der Ereigniszeile.

  • Um die Nutzlast der Ereignisantwort anzuzeigen, klicken Sie auf die Schaltfläche Pfeil-nach-unten-Symbol der Benutzeroberfläche zum Erweitern des Ereignisnutzlast-Menüs am Ende der Ereigniszeile.

    Ereignistyp-Nutzlastinformationen zu Webhooks in der Verwaltungskonsole

Weitere Informationen

Hat diese Seite Ihnen geholfen?

Wenn Sie Probleme mit dieser Seite oder ihren Inhalten feststellen – einen Tippfehler, einen fehlenden Schritt oder einen technischen Fehler –, teilen Sie uns bitte mit, wie wir uns verbessern können!