Вебхуки (Оркестратор)

Контент автоматически переведен с английского языка с помощью Phrase Language AI.

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

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

Входящие вебхуки

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

Настроить входящий вебхук

Чтобы настроить входящий вебхук, выполните следующие шаги:

Перетащите триггер Webhook в рабочий процесс.

Триггер появляется в рабочем процессе.
Нажмите на триггер, чтобы открыть вкладку Overview.
Выберите вкладку Webhook.
1. Скопируйте Webhook URL.
  
  Этот URL следует считать секретным и не делиться им. При случайном обмене нажмите Regenerate, чтобы создать новый и аннулировать существующий.
2. Чтобы отправить полезную нагрузку с данными для использования внутри рабочих процессов, предоставьте схему этой полезной нагрузки.
  1. Чтобы указать схему, нажмите Edit webhook.
  2. Выберите Input Type:
    
    JSON Schemas являются стандартом для определения JSON-пейлоадов. Если существует сервис, который их использует, или внешний сервис для подключения к Orchestrator предоставляет один, скопируйте его как есть.
    - JSON
      
      Предоставьте пример JSON-пейлоада для более простой настройки, позволяя тестировать вебхук без определения точных правил.
    - JSON Schema
      
      Точно определите структуру, типы данных и правила валидации для JSON-данных.
  3. Нажмите Save payload schema.
    
    Предварительный просмотр ожидаемой структуры данных для триггера вебхука отображается.
3. При необходимости откройте вкладку «Filters», чтобы добавить фильтры в триггер.

Чтобы запустить рабочий процесс после его публикации, отправьте POST-запрос на URL вебхука. Для рабочих процессов, у которых не настроена схема, тело должно быть пустым. Если применяется настроенная схема, пейлоад должен соответствовать схеме.

Исходящие вебхуки

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

Вебхуки в других сервисах могут быть инициированы через действие «Отправить HTTP-запрос».

Настроить исходящий вебхук

Чтобы настроить исходящий вебхук, выполните следующие шаги:

Перетащите действие «Send HTTP Request» в рабочий процесс.
Нажмите на действие, чтобы открыть конфигурацию.
Выберите вкладку «Parameters» и задайте необходимые настройки.
Нажмите Save parameters.