Tworzenie webhooków do przepływów pracy i zarządzanie nimi

Wymagane uprawnienia dotyczące webhooków

Podczas tworzenia webhooków lub zarządzania nimi za pomocą interfejsu Webhooks API Qlik Cloud i interfejsu użytkownika automatyzacji należy zażądać jednego lub obu z tych uprawnień:

• Używanie webhooków: wymagane do tworzenia, wyświetlania, aktualizowania i usuwania webhooków należących do użytkownika.

• Zarządzanie webhookami: wymagane do zarządzania wszystkimi webhookami w dzierżawie, w tym tymi utworzonymi przez innych użytkowników.

Jak działają webhooki?

Gdy w Qlik Cloud wystąpi zdarzenie (np. utworzono nową aplikację lub usunięto użytkownika), webhook wysyła informacje w formacie JSON do określonej aplikacji zewnętrznej za pomocą wywołania zwrotnego HTTP. Zewnętrzna aplikacja może następnie wykorzystać dane zdarzenia do uruchomienia dalszych działań.

Na przykład:

• Powiadamianie zespołu przez Slack o utworzeniu nowej aplikacji.

• Automatyczne wysyłanie powitalnej wiadomości e-mail członkowi zespołu nowo dodanemu do dzierżawy.

• Aktualizacja arkusza kalkulacyjnego po usunięciu użytkownika z dzierżawy.

Korzyści z używania webhooków

Webhooki umożliwiają integrację z innymi systemami w czasie rzeczywistym, eliminując potrzebę ciągłych ręcznych kontroli lub powtarzalnych żądań API. Poprzez nasłuchiwanie zdarzeń i natychmiastowe wysyłanie odpowiednich danych webhooki ograniczają zbędną pracę oraz umożliwiają płynną automatyzację.

Popularne platformy do integracji webhooków

W celu obsługi danych z webhooków oraz reagowania na nie, możesz budować niestandardowe usługi lub korzystać z platform firm zewnętrznych, takich jak:

• Qlik Automate (tylko w języku angielskim)

• Pipedream

• Zapier

• Microsoft Power Automate

Limity webhooków

W celu utrzymania wydajności systemu oraz zarządzania zasobami obowiązują następujące limity:

• Historia dostarczania webhooków jest przechowywana przez 7 dni.

• Każdy użytkownik może mieć maksimum 150 webhooków.

• Na jedną dzierżawę można utworzyć maksimum 100 webhooków.

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

Tworzenie webhooków

Webhooki mogą tworzyć:

• Administratorzy dzierżawy z centrum aktywności Administrowanie.

• Wszyscy użytkownicy z interfejsu Qlik Automate.

Więcej informacji na temat korzystania z webhooków i Qlik Automate można znaleźć w temacie Praca z webhookami (tylko w języku angielskim).

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie wybierz pozycję Elementy Webhook.

2. Kliknij polecenie Utwórz nowe.

3. Wprowadź nazwę webhooka oraz opcjonalny opis.

4. W przypadku adresu URL (punktu końcowego) wprowadź w pełni kwalifikowaną nazwę domeny (FQDN), do której webhook będzie wysyłał dane JSON.

   • Ten adres URL musi używać protokołu HTTPS (przykład: https: //domena.com). Adresów IP nie można używać jako punktów końcowych webhooków.

5. Opcjonalnie wprowadź klucz tajny do uwierzytelniania webhooka.

   • Klucz tajny musi składać się z 32–64 znaków.

   • Jeśli zostanie utworzony, klucz tajny zostanie uwzględniony jako część skrótu dołączanego do żądania HTTP jako qlik-signature.

6. Opcjonalnie dodaj nagłówki HTTP do żądania. Zaznacz pole wyboru, aby zaszyfrować wartość nagłówka

   InformacjaZe względów bezpieczeństwa nie można edytować zaszyfrowanych nagłówków. Aby usunąć nagłówek, kliknij ikonę usuwania. Aby usunąć wartość, kliknij ikonę usuwania i wprowadź nową.

7. W sekcji Zdarzenia wybierz zdarzenia systemowe, które będą wyzwalać webhook. Dostępne zdarzenia obejmują:

   • Zdarzenia aplikacji: utworzono, usunięto, wyeksportowano, zaktualizowano (odświeżono) dane, opublikowano, przeładowano.

   • Zdarzenia użytkowników: utworzono, usunięto.

8. Kliknij Utwórz.

Zarządzanie elementami webhook

Filtrowanie i wyszukiwanie webhooków

Sortowanie i wyszukiwanie webhooków w tabeli:

• Kliknij na górze kolumny, aby zmienić kolejność sortowania.

• Kliknij u góry kolumny, aby wyszukać webhook. Filtr wyszukiwania działa w odniesieniu do pełnych i częściowych dopasowań.

Włączanie i wyłączanie webhooków

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie wybierz pozycję Elementy Webhook.

2. Kliknij obok webhooka.

3. Aby włączyć webhook, wybierz Włącz element webhook.

4. Aby wyłączyć webhook, wybierz Wyłącz element webhook.

Nowo utworzone webhooki są domyślnie włączone.

Edytowanie webhooków

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie wybierz pozycję Elementy Webhook.

2. Kliknij przy webhooku do edycji.

3. Wybierz Edytuj.

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

Usuwanie webhooków

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie wybierz pozycję Elementy Webhook.

2. Wybierz element webhook do usunięcia.

3. Kliknij polecenie Usuń.

4. Potwierdź usunięcie.

Przeglądanie historii webhooków

Historia zdarzeń webhooków jest przechowywana przez 7 dni.

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie wybierz pozycję Elementy Webhook.

2. Kliknij obok webhooka, aby rozwinąć jego historię zdarzeń.

   

3. Aby ponownie wysłać ręcznie dostarczenie zdarzenia, kliknij przycisk w wierszu zdarzenia.

4. Aby wyświetlić ładunek reakcji na zdarzenie, kliknij przycisk na końcu wiersza zdarzenia.

   Ładunek pokazuje szczegóły, takie jak identyfikator aplikacji, nazwa i znacznik czasu, co się przydaje do debugowania lub audytu zdarzeń z przeszłości.