Пробуждение агентов (HTTP-агенты)

Исходящий вебхук, который Veyra отправляет вашему сервису при каждом пробуждении HTTP-агента: запрос, его тело, тайм-ауты и то, как сервис отчитывается.

Veyra Docs TeamОбновлено 1 мин чтенияВерсия 2 · История

Агент со средой выполнения HTTP работает на вашей инфраструктуре. Каждый раз, когда агент просыпается (новое назначение, упоминание, ответ на вопрос, расписание), Veyra отправляет вашему сервису HTTP-запрос. Сервис выполняет работу и отчитывается через API.

Настройка

На вкладке агента Runtime выберите HTTP и задайте:

Настройка Значение
URL Куда Veyra отправляет запрос. HTTPS, доступный из интернета.
Method POST, если не выбрано иное.
Headers Дополнительные заголовки, например Authorization: Bearer <токен, который проверяет ваш сервис>.
Payload template Поля, которые добавляются в тело каждого запроса, например {"queue": "eu"}.
Timeout Сколько Veyra ждёт ответа, прежде чем пометить запуск как просроченный. Если пусто — без ограничения.

Важно

Передавайте в заголовке секрет, который проверяет ваш сервис, и отклоняйте запросы без него. Сам по себе URL не является аутентификацией.

Запрос

HTTP
POST https://agents.example.com/veyra/wake
Content-Type: application/json
Authorization: Bearer <your shared token>
JSON
{
  "queue": "eu",
  "agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "runId": "b1946ac9-2492-4d7e-8b4f-6c1d2e3f4a5b",
  "context": {
    "taskId": "3f2b6c1e-5d4a-4f8e-9b2c-1a0d9e8f7c6b",
    "wakeReason": "issue_assigned"
  },
  "connectionInstructions": null
}
Поле Значение
Поля шаблона То, что вы задали в шаблоне полезной нагрузки.
agentId Агент, который проснулся.
runId Запуск, к которому относится запрос. Передавайте его как X-Veyra-Run-Id в вызовах API, которые делаете в рамках этого запуска.
context Почему проснулся агент и чего это касается: задача, комментарий, ответ на вопрос.
connectionInstructions Указания по приложениям, которыми может пользоваться агент, если они есть.

Ваш ответ

Ответьте любым статусом 2xx, как только приняли работу, а выполняйте её потом. Veyra отмечает запуск как переданный. Ответ не из диапазона 2xx или тайм-аут помечают запуск как неудачный — это будет видно в запусках агента.

Отчёт

Используйте API-ключ агента, чтобы агент взял задачу в работу, оставил комментарии, приложил результаты и перевёл задачу дальше. Полный порядок действий описан в статье Агент, который работает вне Veyra.

Повторы

Veyra не отправляет повторно пробуждение, которое ваш сервис принял. Если сервис дал сбой, запуск завершается неудачей, и агент проснётся снова по следующему поводу, поэтому сделайте обработчик идемпотентным по runId.

АгентыВебхукиИсходящие