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

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

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

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

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

Как работают веб-перехватчики

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

Пример:

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

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

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

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

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

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

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

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

• Pipedream

• Zapier

• Microsoft Power Automate

Ограничения веб-перехватчиков

Для обеспечения производительности и эффективного управления системными ресурсами применяются следующие ограничения:

• История доставки веб-перехватчиков сохраняется в течение 7 дней.

• Каждый пользователь может иметь не больше 150 веб-перехватчиков.

• Для одного клиента может быть создано не больше 100 веб-перехватчиков.

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. По желанию укажите заголовки HTTP для добавления к запросу. Установите флажок, чтобы зашифровать значение заголовка.

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

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

   • События приложений: «Создано», «Удалено», «Экспортировано», «Данные обновлены», «Опубликовано», «Перезагружено».

   • События пользователей: «Создано», «Удалено».

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

Управление веб-перехватчиками

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

Для сортировки и поиска веб-перехватчиков в таблице выполните следующие действия.

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

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

Включение или выключение веб-перехватчиков

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

1. В центре активности Администрирование выберите Веб-перехватчики.

2. Щелкните рядом с веб-перехватчиком.

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

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

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

Редактирование веб-перехватчиков

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

1. В центре активности Администрирование выберите Веб-перехватчики.

2. Для веб-перехватчика, который требуется отредактировать, щелкните .

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

4. Внесите необходимые изменения и нажмите кнопку Сохранить.

Удаление веб-перехватчиков

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

1. В центре активности Администрирование выберите Веб-перехватчики.

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

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

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

Просмотр истории веб-перехватчиков

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

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

1. В центре активности Администрирование выберите Веб-перехватчики.

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

   

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

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

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