Вебхук — это метод, позволяющий веб-приложению или сервису отправлять другому веб-сервису информацию практически в реальном времени. Передача данных инициируется конкретным событием или событиями, которые вы задаете. Система не занимается постоянной проверкой обновлений, а уведомляет получателя сразу, как только срабатывает триггер событий.
ArcGIS Online позволяет создавать вебхуки для размещенных векторных слоев, представлений размещенных векторных слоев и размещенных таблиц. Эти вебхуки отправляют полезные данные получателю в соответствии с заданными триггерами событий. Настройки получателя позволяют ему выполнять автоматические действия, например, уведомлять определенных пользователей об изменениях, экспортировать во внешнее приложение информацию о редактировании для создания отчета об изменениях или запускать скрипты контроля качества для обновленных данных.
Основные составляющие этого типа взаимодействия:
- Триггер событий—Каждый триггер события определяет операции API, которые будут вызывать вебхук. Когда пользователь выполняет операцию, указанную в качестве триггера события, вебхук передает информацию об этом (в виде полезных данных) получателю. Вы задаете триггеры при создании вебхука. См. раздел Триггеры событий векторного слоя, чтобы узнать доступные варианты триггеров.
- Полезные данные—Полезные данные содержат информацию, соответствующую вызвавшему триггер событию. См. раздел Полезные данные вебхуков векторного слоя, чтобы узнать, что входит в состав полезных данных.
- Получатель вебхука—Получатель вебхука принимает полезные данные и пересылает информацию заранее определенному списку получателей (пользователей или приложений). Например, он может отправить пользователю письмо или SMS с уведомлением о произошедшем событии, передать информацию о событии во внешнюю базу данных для архивации или запустить скрипт обработки данных на основе произошедшего события.
В качестве получателей вебхуков вы можете использовать сторонние веб-сервисы или собственные решения. Для получения полезных данных необходимо настроить получателей вебхуков на работу по соединению HTTPS и обеспечить организации ArcGIS Online доступ к получателям до добавления вебхука. Получатель вебхуков доступен по URL полезных данных, который вы задаете при создании вебхука.
Получатель вебхуков настраивается вне ArcGIS Online. После настройки получателя вы можете создать вебхук.
Требования
Чтобы вы могли создать вебхук для размещенного векторного слоя, его представления или таблицы, элемент должен соответствовать следующим требованиям:
- Параметр Отслеживать изменения в данных (добавление, обновление, удаление объектов) должен быть включен.
- Элемент не должен находиться в корзине.
У каждого элемента может быть до 10 вебхуков.
Создание вебхука
В таблице приведены типы участников организации, которые могут создавать и управлять вебхуками для размещенных векторных слоев, их представлений и таблиц, а также указана информация о том, где можно управлять вебхуками.
| Тип участника организации | Где можно управлять вебхуками |
|---|---|
Участники с ролью администратора по умолчанию или пользователи с ролью, имеющий набор административных прав на создание и управление вебхуками. |
|
Владельцы элемента |
|
Участники общей группы обновлений, которым был предоставлен доступ к элементу | Вкладка Настройки на странице элемента размещенного векторного слоя, его представления или таблицы—Здесь участник группы может создавать и управлять вебхуками конкретного элемента. |
Чтобы создать вебхук, следуйте инструкциям, соответствующим вашей роли в организации:
- Администратор организации
- Владелец элемента или участник общей группы обновлений, которому был предоставлен доступ к элементу