Orchestrator

Вебхуки (Orchestrator)

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

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

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

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

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

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

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

  1. Перетащите запуск Webhook в рабочий процесс.

    Webhook Example

    Триггер появляется в рабочий процесс.

  2. Нажмите на триггер, чтобы открыть вкладку Overview.

  3. Выберите вкладку Webhook.

    1. Скопируйте Webhook URL.

      Webhook URL Location

      Этот URL-адрес следует считать секретным и не передавать его другим лицам. При случайном обмене нажмите «Regenerate», чтобы создать новый и аннулировать существующий.

    2. Чтобы отправить полезную нагрузку с данными, которые можно использовать внутри рабочий процесс, предоставьте схему этой полезной нагрузки.

      1. Чтобы указать схему, нажмите Edit webhook.

      2. Выберите Input Type:

        JSON-схемы — это стандарт для определения полезных нагрузок JSON. Если существующая услуга использует их или если внешняя услуга для подключения к Orchestrator предоставляет такую схему, скопируйте ее в исходном виде.

        Webhook Input Type
        • JSON

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

        • JSON Schema

          Точно определите структуру, типы данных и правила проверки для данных JSON.

      3. Нажмите Save payload schema.

        Отображается предварительный просмотр ожидаемой структуры данных для триггера вебхук.

    3. При необходимости откройте вкладку «Filters», чтобы добавить фильтры в запуск.

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

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

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

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

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

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

  1. Перетащите действие «Send HTTP Request» в рабочий процесс.

  2. Нажмите на действие, чтобы открыть конфигурацию.

  3. Выберите вкладку «Parameters» и задайте необходимые настройки.

  4. Нажмите Save parameters.

Была ли эта статья полезной?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.