#Отправить событие в процесс

POST /v1/workflows/event

Передаёт выходные значения в приостановленный бизнес-процесс и возобновляет его выполнение. После вызова процесс продолжает работу с переданными значениями в выходных параметрах действия.

#Поля запроса (body)

Поле Тип Обяз. Описание
eventToken string Одноразовый токен приостановленного процесса. Битрикс24 присылает его на handler зарегистрированного действия — см. `/v1/bizproc-activities` или `/v1/bizproc-robots`
returnValues object нет Значения выходных параметров активности. По умолчанию — {}
logMessage string нет Сообщение для журнала выполнения процесса

#Примеры

#curl — личный ключ

Terminal
curl -X POST https://vibecode.bitrix24.tech/v1/workflows/event \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"eventToken":"xxx.yyy.zzz","returnValues":{"result":"approved"}}'

#curl — OAuth-приложение

Terminal
curl -X POST https://vibecode.bitrix24.tech/v1/workflows/event \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"eventToken":"xxx.yyy.zzz","returnValues":{"result":"approved"}}'

#JavaScript — личный ключ

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/workflows/event', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    eventToken: 'xxx.yyy.zzz',
    returnValues: { result: 'approved' },
  }),
})
const data = await res.json()
console.log(data.success) // true

#JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/workflows/event', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    eventToken: 'xxx.yyy.zzz',
    returnValues: { result: 'approved' },
  }),
})

#Поля ответа

Поле Тип Описание
success boolean true при успешной доставке события
data boolean true — событие принято и выполнение процесса возобновлено

#Пример ответа

JSON
{
  "success": true,
  "data": true
}

#Пример ответа при ошибке

403 — недействительный токен:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Access denied!"
  }
}

#Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не передан обязательный параметр eventToken
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный или недействительный API-ключ
401 TOKEN_MISSING У ключа нет подключённых токенов Битрикс24
401 TOKEN_EXPIRED Пользовательская сессия OAuth истекла — повторите авторизацию через /v1/oauth/authorize
403 SCOPE_DENIED Ключу не хватает скоупа bizproc
403 BITRIX_ACCESS_DENIED Битрикс24 отклонил запрос — токен недействителен, истёк или уже использован
422 BITRIX_ERROR Ошибка на стороне Битрикс24
429 RATE_LIMITED Превышен лимит запросов. Повторите через 1–2 секунды
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

Полный список общих ошибок API — Ошибки.

#Известные особенности

  • eventToken — одноразовый. Каждая приостановка бизнес-процесса генерирует новый токен. Токен становится недействительным сразу после вызова /event.
  • Отличие от /v1/workflows/activity-log. Оба эндпоинта принимают eventToken, но /event завершает действие и возобновляет процесс с переданными returnValues, а /activity-log только записывает сообщение в журнал, не изменяя состояние процесса. Для протоколирования промежуточных шагов используйте /activity-log; для финального ответа — /event.

#Смотрите также