Вебхуки уведомляют внешние услуги, такие как чат-клиенты или другие внешние интерфейсы приложений API, о событиях. Вебхук может задать URL-адрес, когда происходит определенное событие.
Phrase Orchestrator предоставляет услугу, которая отслеживает и обрабатывает уведомления от сторонних систем. Эта услуга позволяет пользователям подключать свои рабочие процессы к широкому спектру внешних систем, поддерживающих HTTP-запросы.
Пользователи могут создать новый триггер для входящих вебхуков на основе внешних событий, при этом система автоматически генерирует уникальный URL-адрес вебхука с ключом интерфейса приложений API для настройки вебхука сторонней системы. Сгенерированный URL-адрес вебхука является уникальным и напрямую связан с учетной записью пользователя и рабочим процессом, что означает, что каждый вебхук привязан только к одному рабочему процессу.
Настройка входящего вебхука
Чтобы выполнить настройку вебхука, выполните следующие действия:
-
Перетащите запуск в рабочий процесс.
Триггер появится в рабочем процессе.
-
Нажмите на триггер, чтобы открыть вкладку .
-
Выберите вкладку .
-
Скопируйте .
Этот URL-адрес следует считать секретным и не передавать его другим лицам. При случайном обмене нажмите «Regenerate», чтобы создать новый и аннулировать существующий.
-
Чтобы отправить полезную нагрузку с данными для использования внутри рабочих процессов, предоставьте схему этой полезной нагрузки.
-
Чтобы указать схему, нажмите Edit webhook.
-
Выберите :
JSON-схемы — это стандарт для определения полезных нагрузок JSON. Если существующая услуга использует их или если внешняя услуга для подключения к Orchestrator предоставляет такую схему, скопируйте ее в неизменном виде.
-
JSON
Предоставьте образец полезной нагрузки JSON для более простой настройки, позволяющей протестировать вебхук без определения точных правил.
-
JSON Schema
Точно определите структуру, типы данных и правила проверки для данных JSON.
-
-
Нажмите Save payload schema.
Отображается предварительный просмотр ожидаемой структуры данных для триггера вебхука.
-
-
При необходимости откройте вкладку «», чтобы добавить фильтры в запуск.
-
Чтобы запустить рабочий процесс после его публикации, отправьте POST-запрос на URL-адрес вебхука. Для рабочих процессов, у которых не настроена схема, тело запроса должно быть пустым. Если применяется настроенная схема, полезная нагрузка должна соответствовать совпадению схемы.
Пользователи могут настроить рабочие процессы, которые не только получают данные, но и автоматически отправляют обновления во внешние системы. Действие исходящего вебхука позволяет пользователям автоматически запускать определенные действия во внешних системах.
Вебхуки в других сервисах могут быть запущены с помощью действия «Отправить HTTP-запрос».
Настроить исходящий вебхук
Чтобы настроить исходящий вебхук, выполните следующие действия: