Записать в журнал процесса

POST /v1/workflows/activity-log

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

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

Поле Тип Обяз. Описание
eventToken string ★ Одноразовый токен приостановленного процесса. Битрикс24 присылает его на handler зарегистрированного действия — см. `/v1/bizproc-activities` или `/v1/bizproc-robots`
logMessage string ★ Текст записи журнала. Отображается в журнале выполнения бизнес-процесса в Битрикс24

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/workflows/activity-log \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"eventToken":"xxx.yyy.zzz","logMessage":"Шаг 1 завершён, ожидаем подтверждение"}'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/workflows/activity-log \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"eventToken":"xxx.yyy.zzz","logMessage":"Шаг 1 завершён, ожидаем подтверждение"}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workflows/activity-log', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    eventToken: 'xxx.yyy.zzz',
    logMessage: 'Шаг 1 завершён, ожидаем подтверждение',
  }),
})
const data = await res.json()
console.log(data.success) // true

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workflows/activity-log', {
  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',
    logMessage: 'Шаг 1 завершён, ожидаем подтверждение',
  }),
})

Поля ответа

Поле Тип Описание
success boolean true при успешной записи в журнал
data null Всегда null — эндпоинт не возвращает данных

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

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

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

400 — не переданы обязательные параметры:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: eventToken (string), logMessage (string)"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не передан eventToken или logMessage
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 допускает многократные вызовы /activity-log — каждый добавляет отдельную запись в журнал. Для длительных операций это позволяет отражать прогресс пошагово, прежде чем вызвать `/v1/workflows/event` и завершить действие.

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