Создание вебхуков для рабочих процессов и управление ими

Необходимые разрешения для вебхуков

При создании вебхуков или управлении ими с помощью API вебхуков Qlik Cloud и пользовательского интерфейса автоматизаций необходимо запросить одно или оба из следующих разрешений:

• Использовать вебхуки: требуется для создания, просмотра, обновления и удаления вебхуков, принадлежащих пользователю.

• Управление вебхуками: требуется для управления всеми вебхуками в клиенте, включая созданные другими пользователями.

Как работают вебхуки

Когда в Qlik Cloud происходит событие (например, создается новое приложение или удаляется пользователь), вебхук отправляет информацию в формате JSON в указанное внешнее приложение с помощью обратного вызова HTTP. Затем это внешнее приложение может использовать данные о событии для запуска дальнейших действий.

Например:

• Уведомлять команду через Slack при создании нового приложения.

• Автоматически отправлять приветственное электронное письмо при добавлении нового участника команды в клиент.

• Обновлять электронную таблицу при удалении пользователя из клиента.

Преимущества использования вебхуков

Вебхуки обеспечивают интеграцию с другими системами в режиме реального времени, устраняя необходимость в постоянных ручных проверках или повторяющихся запросах API. Отслеживая события и немедленно отправляя соответствующие данные, вебхуки сокращают объем ненужной работы и обеспечивают бесперебойную автоматизацию.

Популярные платформы для интеграции вебхуков

Для обработки данных вебхуков и реагирования на них можно создавать пользовательские службы или использовать сторонние платформы, такие как:

• Qlik Automate (только английский язык)

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

Создание вебхуков

Вебхуки могут быть созданы:

• Администраторами клиента из центра активности Администрирование.

• Всеми пользователями из интерфейса Qlik Automate.

Для получения дополнительной информации об использовании вебхуков с Qlik Automate см. раздел Работа с вебхуками (только английский язык).

Выполните следующие действия.

1. В центре активности Администрирование перейдите в раздел Вебхуки.

2. Нажмите Создать новый.

3. Введите имя вебхука и, при необходимости, добавьте описание.

4. Для URL-адреса (конечной точки) введите полное доменное имя (FQDN), на которое вебхук будет отправлять данные JSON.

   • Этот URL-адрес должен использовать протокол HTTPS (например: https://domain.com). IP-адреса не могут использоваться в качестве конечных точек вебхука.

5. При необходимости введите секрет для аутентификации вебхука.

   • Секрет должен содержать от 32 до 64 символов.

   • Если секрет создан, он будет включен как часть хэша, добавленного к HTTP-запросу в виде qlik-signature.

6. Облачное событие Полезная нагрузка события, генерируемая службой вебхуков Qlik Cloud. После включения и сохранения это изменение нельзя отменить.

7. Проверка отзыва сертификата при включении проверяет, что сертификаты вебхука действительны и не отозваны.

8. При необходимости добавьте заголовки HTTP для добавления к запросу. Установите флажок, чтобы зашифровать значение заголовка

   Примечание к информацииВ целях безопасности вы не можете редактировать зашифрованные заголовки; чтобы удалить заголовок, нажмите значок удаления. Чтобы удалить значение, нажмите значок удаления и введите новое.

9. В разделе События выберите системные события, которые будут запускать вебхук. Доступные события включают:

   • События автоматизации

   • События API

   • События приложения

   • События интеграции данных

   • События пользователя

10. Нажмите Создать.

Управление вебхуками

Примечание к информации

Вебхуки, созданные с помощью Qlik Automate, можно просматривать только в центре активности Администрирование. Их нельзя редактировать, удалять, включать или отключать.

Для управления этими вебхуками используйте интерфейс Qlik Automate.

Сортировка и поиск вебхуков

Для сортировки и поиска вебхуков в таблице:

• Нажмите в верхней части столбца, чтобы изменить порядок сортировки.

• Нажмите в верхней части столбца для поиска вебхука. Фильтр поиска работает для полных и частичных совпадений.

Включение или отключение вебхуков

Выполните следующие действия.

1. В центре активности Администрирование перейдите в раздел Вебхуки.

2. Нажмите рядом с вебхуком.

3. Чтобы включить вебхук, выберите Включить.

4. Чтобы отключить вебхук, выберите Отключить.

Вновь созданные вебхуки включены по умолчанию.

Редактирование вебхуков

Выполните следующие действия.

1. В центре активности Администрирование перейдите в раздел Вебхуки.

2. Для вебхука, который необходимо отредактировать, нажмите .

3. Выберите Изменить.

4. Внесите изменения и нажмите Сохранить.

Примечание к информацииЕсли нажать Отмена при наличии несохраненных изменений, появится диалоговое окно подтверждения. Нажмите Отменить, чтобы закрыть без сохранения изменений.

Удаление вебхуков

Выполните следующие действия.

1. В центре активности Администрирование перейдите в раздел Вебхуки.

2. Выберите вебхук для удаления.

3. Нажмите Удалить.

4. Подтвердите удаление.

Примечание к информацииКнопка Удалить недоступна, пока не будет выбран один или несколько вебхуков. На панели действий отображается количество выбранных вебхуков.

Просмотр истории вебхуков

История событий вебхуков хранится в течение 7 дней.

Выполните следующие действия.

1. В центре активности Администрирование перейдите в раздел Вебхуки.

2. Нажмите рядом с вебхуком, чтобы развернуть историю его событий.

   

3. Чтобы вручную повторно отправить доставку события, нажмите в строке события.

4. Чтобы просмотреть полезную нагрузку ответа на событие, нажмите в строке события.

   Полезная нагрузка показывает такие сведения, как идентификатор приложения, имя и метка времени, что полезно для отладки или аудита прошлых событий.