Как создать и настроить вебхуки в TARGPatrol
Вебхук — это автоматическое уведомление, которое отправляет сервер TARGPatrol на ваш сервер, как только в системе происходят определенные действия, например, создание задачи, обновление ее статуса или завершение. Вебхуки полезны для автоматизации процессов, интеграции с другими системами и реагирования на изменения в режиме реального времени.Когда в TARGPatrol происходит событие (event), например, задача меняет статус, система отправляет POST-запрос на заранее настроенный URL. Этот запрос содержит полезную нагрузку (payload) с деталями события, такими как ID задачи, статус и другая связанная информация.
Настройка вебхуков в TARGPatrol
Чтобы создать вебхук:
Авторизуйтесь в TARGPatrol;
Откройте вкладку "Управление" -> "Вебхуки".
Добавьте новый вебхук:
Нажмите на кнопку "Добавить вебхук".
Введите URL, на который будут отправляться уведомления. Убедитесь, что ваш сервер готов принимать POST-запросы и обрабатывать данные в формате JSON.
Выберите типы событий для вебхука. В TARGPatrol доступны различные триггеры: создание задачи, редактирование задачи, создание происшествия и т.д.
В случае необходимости добавьте Заголовки запроса (например, content-type).
Нажмите "Сохранить".
Тестирование вебхука:
После настройки, TARGPatrol предоставляет возможность отправить запрос.
Например, если вы создали вебхук с типом события task.created, то при создании задачи сформируется уведомления.
Вебхук TASK_STEP_COMPLETED
Выберите TASK_STEP_COMPLETED, чтобы отправлять отдельный вебхук каждый раз, когда шаг задачи переходит в завершенное состояние. В списке событий он отображается как «task.step completed».
Payload содержит сведения об организации, запланированной задаче и ее истории, выполнении задачи, локации, исполнителе и признаке отметки по требованию. Объект шага может включать следующие поля:
id, name, order и actualOrder: идентификатор, название, общий и фактический порядок выполнения шага.
pointId и pointHistoryId: ссылки на контрольную точку и ее историю, если точка используется в шаге.
stepGroupId: ссылка на группу, если шаг входит в группу шагов.
state, status, startedAt и endedAt: состояние, результат и время выполнения.
Необязательные поля отсутствуют, если они неприменимы. Ваш endpoint должен определять событие по типу TASK_STEP_COMPLETED и обрабатывать каждый завершенный шаг отдельно.
Просмотр вебхуков в TARGPatrol
Откройте страницу “Webhooks” в TARGPatrol.
В таблице с запросами нажмите на название (URL) нужного вебхука либо значок.
Откроется окно с историей выполнения событий, статусом, запросов и ответом сервера (правая часть страницы).
Если выполнение было неуспешное, то данный запрос будет отображен в истории с соответствующей иконкой. В случае, если было выполнено 25 ��екорректных запросов подряд, то вебхук будет автоматически отключен.
Советы по работе с вебхуками в TARGPatrol
Обработка ошибок. Вебхуки работают в режиме реального времени, но если ваш сервер не отвечает, TARGPatrol поддерживает автоматические повторные попытки отправки.
Анализ частых ошибок. Если вы видите систематические ошибки (например, регулярные тайм-ауты), это может указывать на проблемы с производительностью вашего сервера или с конфигурацией маршрутизации.
Уведомления. При формировании нового вебхука, систематических ошибках либо автоматическом отключении вебхука вам на почту будут отправляться соответствующие письма, что поможет вам всегда быть в курсе работоспособности вашей интеграции.
Безопасность данных. Вебхуки TARGPatrol используют только URL с HTTPS.
Настройка вебхуков в TARGPatrol открывает возможности для автоматизации задач, интеграции с другими системами и работы с данными в реальном времени. Следуйте советам по управлению вебхуками, чтобы избежать распространенных ошибок и обеспечить стабильную работу интеграции. Используйте HTTPS для безопасности, анализируйте ошибки для устранения проблем, и будьте в курсе состояния ваших вебхуков благодаря уведомлениям TARGPatrol. С правильной настройкой вы сможете эффективно управлять процессами и улучшить производительность своей команды.