Вебхук: как работает триггер Universal Webhook?
Вебхук Universal Webhook запускает процесс AI Flowi Workflow, когда на его рабочую конечную точку приходит запрос с разрешённым HTTP-методом. Он поддерживает пять методов: GET, POST, PUT, PATCH и DELETE. Request Data — нормализованный JSON-выход; тестовая конечная точка фиксирует запросы, не выполняя процесс. См. обзор коммерческих интеграций.
Автор: Ai Flowi · Техническая проверка: Janice Lee, техническая поддержка, Ai Flowi.
Опубликовано · Обновлено
Что такое вебхук?
Вебхук позволяет другой системе отправить запрос на конечную точку, которая запускает ваш рабочий процесс. В Universal Webhook рабочая конечная точка выполняет настроенный процесс и преобразует входящий запрос в JSON-данные для последующих компонентов, а тестовая конечная точка фиксирует запрос для проверки без запуска процесса. Прочитайте обзор событийно-ориентированной архитектуры, чтобы понять место входящего запроса в общей схеме рабочего процесса.
Как подключиться к вебхуку?
Настройте принимаемый HTTP-метод, аутентификацию и режим ответа, затем настройте отправителя так, чтобы он обращался к сгенерированной рабочей конечной точке выбранным методом. Platform API Key использует политику аутентификации вебхуков платформы; для External Provider проверку нужно настроить в самом процессе. Используйте тестовую конечную точку, чтобы зафиксировать и проверить запрос без выполнения рабочего процесса.
Принимаемые запросы
| Настройка или выход | Поведение согласно документации |
|---|---|
| HTTP Methods | Выберите один или несколько методов: GET, POST, PUT, PATCH и DELETE. |
| Request Data | Нормализованный JSON-выход может включать параметры запроса, заголовки, тело в формате JSON или формы, исходное тело, загруженные файлы и метаданные запроса. |
| Production Endpoint | Сгенерированная конечная точка для запросов, выполняющих настроенный процесс. |
| Test Endpoint | Фиксирует запрос для Fetch Latest Payload. Не выполняет процесс. |
Проверьте синтетический запрос с помощью валидатора JSON; проверка синтаксиса не заменяет валидацию полей или аутентификацию.
Чтобы начать с примера для конкретной задачи, изучите валидатор входных данных вебхука; проверьте его типизированные соединения, настройки и заявленный объём тестирования.
Аутентификация перед передачей адреса конечной точки
Выберите Authentication, прежде чем передавать адрес рабочей конечной точки. Platform API Key сохраняет политику аутентификации вебхуков платформы, поэтому отправитель должен передавать API-ключ платформы, требуемый этой политикой. External Provider пропускает запросы без API-ключа платформы, чтобы процесс мог выполнить проверку, специфичную для провайдера. Если вы выбрали External Provider, настройте эту проверку в процессе прежде чем передавать адрес конечной точки; сама настройка не проверяет отправителя. Справочник компонента не указывает заголовок для ключа или формат его передачи, поэтому настройте отправителя по инструкциям платформы для используемого API-ключа.
Тестовая конечная точка позволяет предварительно проверить настроенный ответ, если выполнение процесса не требуется. Fetch Latest Payload может получить последний запрос, принятый любой из двух конечных точек. Проверьте зафиксированные значения, прежде чем подключать Request Data к последующим компонентам; руководство по передаче данных из вебхука в Google Sheets показывает описанную в документации дальнейшую обработку.
Режимы ответа
Режим ответа задаётся для каждого принимаемого метода. Immediate возвращает настроенный для этого метода ответ, пока процесс выполняется в фоновом режиме. After Execution ждёт завершения процесса, затем возвращает настроенный ответ. From Flow ждёт выполнения процесса и получает ответ от одного компонента Webhook Response. Для режима From Flow убедитесь, что на выполняемом пути процесса срабатывает ровно один компонент Webhook Response.
Если отправитель получает HTTP 405, проверьте, что его метод разрешён и входит в список описанных выше методов. Если ответ From Flow не удаётся определить, проверьте количество компонентов ответа. См. устранение ошибок вебхуков, где описаны соответствующие проверки. Чтобы интерпретировать ответ отправителю, используйте справочник кодов состояния HTTP, прежде чем исследовать настройки метода.