Перейти к содержимому
LegalStack

Включить или отключить вебхук задания

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

POST/ws/api/agents/{agentId}/schedules/{scheduleId}/webhook

Авторизация

dpop
AuthorizationBearer <токен>

Access token, привязанный к ключу клиента по RFC 9449: заголовок Authorization: DPoP <token> и заголовок DPoP с доказательством для каждого запроса. Сервер выдаёт DPoP-Nonce, который клиент включает в доказательство.

Передаётся в: header

Параметры пути

agentId*string

Идентификатор агента

Форматuuid
scheduleId*string

Идентификатор задания

Форматuuid

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

Тело ответа

application/json

application/problem+json

curl -X POST "https://example.com/ws/api/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhook" \  -H "Authorization: Bearer <access_token>" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'
{  "schedule": {    "agentId": "string",    "channels": [      "chat"    ],    "conversationId": "string",    "createdAt": "string",    "endsOn": "string",    "hold": {      "at": "string",      "byUserId": "string",      "reason": "string"    },    "id": "string",    "lastFailed": true,    "lastRunAt": "string",    "name": "string",    "nextRunAt": "string",    "origin": "chat",    "overlap": "skip",    "prompt": "string",    "quotaPaused": true,    "repeatDone": 0,    "repeatTimes": 0,    "schedule": "string",    "startsOn": "string",    "state": "active",    "upcoming": [      {        "at": "string",        "label": "string"      }    ],    "userId": "string",    "waiting": true,    "webhook": true  },  "url": "string"}