Tworzenie i zarządzanie webhookami dla przepływów pracy

Wymagane uprawnienia dla webhooków

Podczas tworzenia lub zarządzania webhookami za pomocą Webhooks API Qlik Cloud oraz interfejsu użytkownika automatyzacji, musisz 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 (na przykład zostanie utworzona nowa aplikacja lub usunięty użytkownik), webhook wysyła informacje w formacie JSON do określonej aplikacji zewnętrznej za pomocą wywołania zwrotnego HTTP. Ta zewnętrzna aplikacja może następnie użyć danych o zdarzeniu do wyzwolenia dalszych działań.

Na przykład:

• Powiadomienie zespołu przez Slack, gdy zostanie utworzona nowa aplikacja.

• Automatyczne wysłanie powitalnej wiadomości e-mail, gdy nowy członek zespołu zostanie dodany do dzierżawy.

• Aktualizacja arkusza kalkulacyjnego, gdy użytkownik zostanie usunięty 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łego ręcznego sprawdzania lub powtarzających się żądań API. Nasłuchując zdarzeń i natychmiast wysyłając odpowiednie dane, webhooki redukują niepotrzebną pracę i umożliwiają płynną automatyzację.

Popularne platformy do integracji webhooków

Aby obsługiwać dane webhooków i na nie reagować, możesz tworzyć niestandardowe usługi lub korzystać z platform innych firm, takich jak:

• Qlik Automate (tylko w języku angielskim)

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

Tworzenie webhooków

Webhooki mogą być tworzone przez:

• Administratorów dzierżawy z centrum aktywności Administrowanie.

• Wszystkich użytkowników z interfejsu Qlik Automate.

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

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie przejdź do Webhooki.

2. Kliknij Utwórz nowy.

3. Wprowadź nazwę webhooka i opcjonalnie dodaj opis.

4. W polu URL (punkt końcowy) 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://domain.com). Adresy IP nie mogą być używane jako punkty końcowe webhooków.

5. Opcjonalnie wprowadź wpis tajny do uwierzytelniania webhooka.

   • Wpis tajny musi mieć od 32 do 64 znaków.

   • Jeśli zostanie utworzony, wpis tajny zostanie dołączony jako część skrótu, dodany do żądania HTTP jako qlik-signature.

6. Zdarzenie w chmurze Ładunek zdarzenia emitowany przez usługę Qlik Cloud Webhooks. Po włączeniu i zapisaniu zmiany nie można cofnąć.

7. Sprawdź unieważnienie certyfikatu po włączeniu weryfikuje, czy certyfikaty webhooka są ważne i nie zostały unieważnione.

8. Opcjonalnie dodaj nagłówki HTTP, które zostaną dołączone 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ą.

9. W sekcji Zdarzenia wybierz zdarzenia systemowe, które wyzwolą webhooka. Dostępne zdarzenia obejmują:

   • Zdarzenia automatyzacji

   • Zdarzenia API

   • Zdarzenia aplikacji

   • Zdarzenia integracji danych

   • Zdarzenia użytkownika

10. Kliknij Utwórz.

Zarządzanie webhookami

Informacja

Webhooki utworzone za pomocą Qlik Automate można przeglądać tylko w centrum aktywności Administrowanie. Nie można ich edytować, usuwać, włączać ani wyłączać.

Aby zarządzać tymi webhookami, użyj interfejsu Qlik Automate.

Sortowanie i wyszukiwanie webhooków

Aby sortować i wyszukiwać webhooki w tabeli:

• Kliknij u góry kolumny, aby zmienić porządek sortowania.

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

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

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie przejdź do Webhooki.

2. Kliknij obok webhooka.

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

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

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

Edytowanie webhooków

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie przejdź do Webhooki.

2. Dla webhooka, którego chcesz edytować, kliknij .

3. Wybierz Edytuj.

4. Wprowadź zmiany i kliknij Zapisz.

InformacjaJeśli klikniesz Anuluj, gdy istnieją niezapisane zmiany, pojawi się okno dialogowe potwierdzenia. Kliknij Odrzuć, aby zamknąć bez zapisywania zmian.

Usuwanie webhooków

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie przejdź do Webhooki.

2. Wybierz webhooka do usunięcia.

3. Kliknij Usuń.

4. Potwierdź usunięcie.

InformacjaPrzycisk Usuń jest niedostępny, dopóki nie wybierzesz jednego lub więcej webhooków. Na pasku działań wyświetlana jest liczba wybranych webhooków.

Wyświetlanie historii webhooka

Historia zdarzeń webhooka jest przechowywana przez 7 dni.

Wykonaj następujące czynności:

1. W centrum aktywności Administrowanie przejdź do Webhooki.

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

   

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

4. Aby wyświetlić ładunek odpowiedzi na zdarzenie, kliknij w wierszu zdarzenia.

   Ładunek pokazuje szczegóły, takie jak identyfikator aplikacji, nazwa i znacznik czasu, co jest przydatne do debugowania lub audytu przeszłych zdarzeń.