Вебхук (Webhook)
Компонент Webhook позволяет инициировать запуск вашего потока посредством внешнего события через HTTP POST-запрос. Использование данного модуля фактически превращает созданную схему (flow) в полноценный API-эндпоинт, доступный для внешних сервисов и приложений.
Интеграция через Webhook
При добавлении этого компонента в рабочую область система активирует дополнительные возможности взаимодействия. В панели API Access автоматически генерируется пример программного кода, предназначенный для выполнения вызова вашего потока из сторонних сред разработки или систем автоматизации.
curl -X POST \
"http://<vash-ai-server>/api/v1/webhook/<flow_id>" \
-H 'Content-Type: application/json' \
-H 'x-api-key: <vash_api_key>' \
-d '{"key": "value"}'Параметры
| Техническое имя | Отображаемое имя | Описание |
|---|---|---|
data | Payload | Входной параметр. Получает полезную нагрузку от внешних систем через HTTP POST-запросы. |
curl | curl | Входной параметр. Шаблон команды curl для выполнения запросов к данному вебхуку. |
endpoint | Endpoint | Входной параметр. URL-адрес конечной точки, на которую вебхук принимает запросы. |
output_data | Data | Выходной параметр. Обработанные данные из входящего запроса вебхука. Возвращает пустой объект Data, если входные данные отсутствуют. Если входные данные не являются валидным JSON, компонент оборачивает их в объект payload для запуска потока. |