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