Erstellen und Verwalten von Webhooks für Workflows

Erforderliche Webhook-Berechtigungen

Wenn Sie Webhooks mit der Qlik Cloud Webhooks API und der Automatisierungs-UI erstellen oder verwalten, müssen Sie eine oder beide der folgenden Berechtigungen anfordern:

• Webhooks verwenden: Erforderlich zum Erstellen, Anzeigen, Aktualisieren und Löschen von Webhooks, die dem Benutzer gehören.

• Webhooks verwalten: Erforderlich, um alle Webhooks im Mandanten zu verwalten, einschließlich derer, die von anderen Benutzern erstellt wurden.

Funktionsweise von Webhooks

Wenn ein Ereignis in Qlik Cloud eintritt (z. B. wenn eine neue App erstellt oder ein Benutzer gelöscht wird), sendet ein Webhook Informationen im JSON-Format über einen HTTP-Callback an eine bestimmte externe Anwendung. Diese externe Anwendung kann dann die Ereignisdaten verwenden, um weitere Aktionen auszulösen.

Beispiel:

• Ihr Team über Slack benachrichtigen, wenn eine neue App erstellt wird

• Automatisch eine Begrüßungs-E-Mail senden, wenn ein neues Teammitglied zu einem Mandanten hinzugefügt wird

• Automatisch eine Tabelle aktualisieren, wenn ein Benutzer vom Mandanten gelöscht wird

Vorteile der Verwendung von Webhooks

Webhooks ermöglichen die Integration mit anderen Systemen in Echtzeit und machen ständige manuelle Überprüfungen oder repetitive API-Anforderungen überflüssig. Sie warten auf Ereignisse und senden die entsprechenden Daten sofort. Damit reduzieren Webhooks unnötige Arbeit und ermöglichen eine reibungslose Automatisierung.

Beliebte Plattformen für Webhook-Integrationen

Für die Verarbeitung und Beantwortung von Webhook-Daten können Sie benutzerdefinierte Dienste erstellen oder Drittanbieter-Plattformen wie die Folgenden verwenden:

• Qlik Automate (nur auf Englisch)

• Pipedream

• Zapier

• Microsoft Power Automate

Beschränkungen für Webhooks

Die folgenden Beschränken gelten, um die Systemleistung zu schützen und Ressourcen zu verwalten:

• Der Zustellungsverlauf von Webhooks wird für 7 Tage gespeichert.

• Jeder Benutzer kann maximal 150 Webhooks besitzen.

• Es können maximal 100 Webhooks pro Mandant erstellt werden.

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

Erstellen von Webhooks

Webhooks können von folgenden Personen erstellt werden:

• von Mandantenadministratoren über das Aktivitätscenter Administration.

• von allen Benutzern über die Qlik Automate-Benutzeroberfläche.

Weitere Informationen zur Verwendung von Webhooks mit Qlik Automate finden Sie unter Arbeiten mit Webhooks (nur auf Englisch).

Gehen Sie folgendermaßen vor:

1. Gehen Sie im Aktivitätscenter Administration zu Webhooks.

2. Klicken Sie auf Neu erstellen.

3. Geben Sie einen Namen und optional eine Beschreibung für den Webhook ein.

4. Geben Sie für die URL (Endpunkt) den vollständig qualifizierten Domänennamen (FQDN) ein, an den der Webhook JSON-Daten senden soll.

   • Diese URL muss das HTTPS-Protokoll verwenden (Beispiel: https: //domaene.com). IP-Adressen können nicht als Webhook-Endpunkte verwendet werden.

5. Geben Sie optional einen Schlüssel für die Webhook-Authentifizierung ein.

   • Der Schlüssel muss zwischen 32 und 64 Zeichen lang sein.

   • Falls erstellt, wird der Schlüssel in einen Hash eingeschlossen, der als qlik-signature an die HTTP-Anforderung angehängt wird.

6. Fügen Sie optional HTTP-Header zum Anhängen an die Anforderung hinzu. Aktivieren Sie das Kontrollkästchen, um den Header-Wert zu verschlüsseln.

   InformationshinweisAus Sicherheitsgründen können Sie verschlüsselte Header nicht bearbeiten. Um den Header zu löschen, klicken Sie auf das Löschsymbol. Um den Wert zu entfernen, klicken Sie auf das Entfernen-Symbol und geben Sie einen neuen Wert ein.

7. Wählen Sie unter Ereignisse die Systemereignisse aus, die den Webhook auslösen sollen. Zu den verfügbaren Ereignisse zählen:

   • App-Ereignisse: erstellt, gelöscht, exportiert, Daten aktualisiert, veröffentlicht, geladen

   • Benutzerereignisse: erstellt, gelöscht

8. Klicken Sie auf Erstellen.

Verwalten von Webhooks

Sortieren von und Suchen nach Webhooks

So sortieren Sie Webhooks in der Tabelle und suchen danach:

• Um die Sortierreihenfolge zu ändern, klicken Sie am oberen Rand einer Spalte auf .

• Um nach einem Webhook zu suchen, klicken Sie am oberen Rand einer Spalte auf . Der Suchfilter funktioniert für vollständige und für teilweise Übereinstimmungen.

Aktivieren oder Deaktivieren von Webhooks

Gehen Sie folgendermaßen vor:

1. Gehen Sie im Aktivitätscenter Administration zu Webhooks.

2. Klicken Sie neben dem Webhook auf .

3. Zum Aktivieren des Webhooks klicken Sie auf Webhook aktivieren.

4. Zum Deaktivieren des Webhooks klicken Sie auf Webhook deaktivieren.

Neu erstellte Webhooks sind standardmäßig aktiviert.

Bearbeiten von Webhooks

Gehen Sie folgendermaßen vor:

1. Gehen Sie im Aktivitätscenter Administration zu Webhooks.

2. Klicken Sie für den Webhook, den Sie bearbeiten möchten, auf .

3. Wählen Sie Bearbeiten aus.

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

Löschen von Webhooks

Gehen Sie folgendermaßen vor:

1. Gehen Sie im Aktivitätscenter Administration zu Webhooks.

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

3. Klicken Sie auf Löschen.

4. Bestätigen Sie das Löschen.

Anzeigen des Webhook-Verlaufs

Der Ereignisverlauf von Webhooks wird für 7 Tage gespeichert.

Gehen Sie folgendermaßen vor:

1. Gehen Sie im Aktivitätscenter Administration zu Webhooks.

2. Klicken Sie neben einem Webhook auf , um den Ereignisverlauf zu erweitern.

   

3. Um eine Ereigniszustellung manuell erneut zu senden, klicken Sie in der Ereigniszeile auf.

4. Um die Nutzlast der Ereignisantwort anzuzeigen, klicken Sie in der Ereigniszeile auf .

   Die Nutzlast zeigt Details wie App-ID, Name und Zeitstempel, die für das Debuggen oder Prüfen vergangener Ereignisse nützlich sind.