Przeskocz do zawartości głównej

Tworzenie elementów webhook do przepływów pracy

Elementy webhook umożliwiają używanie zdarzeń systemowych Qlik Sense jako wyzwalaczy w przepływie pracy. Po utworzeniu elementu webhook automatycznie wysyła on żądanie JSON do swojego punktu końcowego za każdym razem, gdy wystąpi zdefiniowane zdarzenie systemowe. Za pomocą elementów webhook można wysyłać dane o zdarzeniach do dowolnej aplikacji, która może odbierać dane JSON.

Właściwości elementu webhook

Aby utworzyć element webhook, musisz skonfigurować właściwości elementu webhook i punktu końcowego, a następnie wybrać typy zdarzeń Qlik Sense.

Właściwości elementu webhook
Właściwość Opis
Nazwa Nazwa elementu webhook.
Opis (opcjonalnie) Opis elementu webhook.
URL Adres URL punktu końcowego elementu webhook. Adres URL (punkt końcowy elementu webhook) musi być w pełni kwalifikowaną nazwą domeny (FDQN) i używać protokołu HTTPS. Punkt końcowy nie może być adresem IP.
Klucz tajny (opcjonalnie) Klucz tajny do uwierzytelniania elementu webhook. Klucz tajny musi mieć co najmniej 32 i maksymalnie 64 znaki. Jeśli utworzysz klucz tajny elementu webhook, będzie on częścią skrótu, który jest dołączany do żądania HTTP jako qlik-signature.
Nagłówki (opcjonalnie)

Nagłówki, które można dołączyć do żądania HTTP.

Każdy element webhook jest skonfigurowany z co najmniej jednym typem zdarzenia.

Typy zdarzeń dla elementów webhook
Zasób Typy zdarzeń
Aplikacje Utworzono, usunięto, zaktualizowano dane, załadowano, opublikowano, wyeksportowano
Uwaga: Zdarzenie aktualizacji danych odnosi się do odświeżenia danych. Zdarzenie ładowania odnosi się do ładowania danych w tabelach aplikacji Qlik Sense i powiązanych tabelach danych.
Użytkownicy Utworzono, usunięto

Element webhook czeka na wystąpienie jednego ze zdarzeń, a gdy to nastąpi, wysyła dane zdarzenia do swojego punktu końcowego. Dane są przekazywane na adres URL punktu końcowego jako żądanie JSON.

Uwaga: Aby dowiedzieć się więcej o ładunkach zdarzeń, zobacz Portal dla deweloperów Qlik: Zdarzenia API.

Przykład: Żądanie JSON dotyczące typu zdarzenia usunięto aplikację

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

Tworzenie elementu webhook

Elementy webhook tworzy się z poziomu konsoli Management Console w sekcji Integracja > Elementy webhook.

Uwaga: Możesz utworzyć maksymalnie 100 elementów webhook dla każdej dzierżawy.
  1. W prawym górnym rogu kliknij przycisk Utwórz.

  2. W oknie dialogowym Utwórz element webhook wprowadź nazwę elementu webhook.

  3. Dodaj opcjonalny opis.

  4. Wprowadź adres URL w celu połączenia ze zintegrowaną aplikacją zewnętrzną.

  5. Opcjonalnie wprowadź klucz tajny, który ma być dołączony do żądania HTTP.

  6. Opcjonalnie dodaj nagłówki HTTP do żądania.

  7. W obszarze Zdarzenia wybierz typy zdarzeń dla elementu webhook.

  8. Na koniec kliknij przycisk Utwórz.

    Elementy webhook są wymienione w tabeli. Nowo utworzone elementy webhook są domyślnie włączone.

Management console webhooks table
Porada: Element webhook możesz włączyć lub wyłączyć, klikając Three dots UI icon to open the options menu for the webhook na końcu jego wiersza i wybierając Włącz element webhook lub Wyłącz element webhook. Elementy webhook są domyślnie włączone.
Porada: Elementy webhook w tabeli możesz sortować i wyszukiwać, klikając ikonę The up-down arrow icon to sort the column values u góry dowolnej kolumny, aby zmienić kolejność sortowania, lub klikając ikonę filtru The filter icon at the top of each webhook column u góry każdej kolumny, aby ręcznie wyszukać element webhook. Filtr wyszukiwania działa w odniesieniu do pełnych i częściowych dopasowań.

Edytowanie elementu webhook

Elementy webhook można edytować z poziomu konsoli Management Console w sekcji Integracja > Elementy webhook.

  1. W przypadku elementu webhook, który chcesz edytować, kliknij przycisk Three dots UI icon to open the options menu for the webhook na końcu wiersza.

  2. Kliknij Edytuj.

    Zostanie wyświetlony panel edycji z opcjami zmiany konfiguracji elementu webhook.

  3. Wprowadź żądane zmiany i kliknij Zapisz.

Usuwanie elementu webhook

Elementy webhook można usunąć z konsoli Management Console, w sekcji Integracja > Elementy webhook.

  1. Wybierz element webhook do usunięcia.

  2. W prawym górnym rogu kliknij przycisk Usuń.

  3. Otworzy się wyskakujące okno dialogowe w celu potwierdzenia wyboru Kliknij polecenie Usuń.

Przeglądanie historii elementu webhook

Dostęp do historii elementu webhook uzyskuje się z konsoli Management Console, w sekcji Integracja > Elementy webhook.

Uwaga: Dostarczone zdarzenia są usuwane z historii elementu webhook po 7 dniach.
  • Aby wyświetlić historię elementu webhook, kliknij przycisk Down arrow UI icon to expand the webhook menu na końcu jego wiersza.

    Zostanie wyświetlona historia elementu webhook.

    Management console webhook history

  • Aby ponownie wysłać ręcznie dostarczenie zdarzenia, kliknij przycisk The resend icon used to resend the webhook na końcu wiersza zdarzenia.

  • Aby wyświetlić dane odpowiedzi na zdarzenie, kliknij przycisk Down arrow UI icon to expand the event payload menu na końcu wiersza zdarzenia.

    Management console webhook event type payload information