Активировать триггер

POST /v1/triggers/fire

Отправляет сигнал об активации автоматизации для заданной CRM-сущности. Битрикс24 запускает все роботы и действия, настроенные для указанного триггера на соответствующем шаге воронки.

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

Поле Тип Обяз. Описание
entityType string ★ Тип CRM-сущности: deal, lead, contact, company, quote, invoice, item
entityId number ★ ID CRM-сущности. Источник: GET /v1/deals, GET /v1/leads, GET /v1/contacts, GET /v1/companies, GET /v1/quotes, GET /v1/invoices. Для item — ID элемента из GET /v1/items/:entityTypeId
entityTypeId number ID типа смарт-процесса. Обязателен при entityType: item. Список типов: GET /v1/smart-processes
triggerId string ★ Код триггера. Список кодов: `GET /v1/triggers`, поле CODE

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/triggers/fire \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entityType":"deal","entityId":5141,"triggerId":"payment_received"}'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/triggers/fire \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"entityType":"deal","entityId":5141,"triggerId":"payment_received"}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/triggers/fire', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityType: 'deal',
    entityId: 5141,
    triggerId: 'payment_received',
  }),
})
const data = await res.json()
console.log(data.success, data.data) // true, true

curl — счёт (SmartInvoice)

Счёт — это смарт-счёт (динамический тип CRM). Передайте entityType: "invoice" и ID счёта из GET /v1/invoices:

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/triggers/fire \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entityType":"invoice","entityId":42,"triggerId":"payment_received"}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/triggers/fire', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityType: 'deal',
    entityId: 5141,
    triggerId: 'payment_received',
  }),
})
const data = await res.json()

Поля ответа

Поле Тип Описание
success boolean true при успешной отправке сигнала
data boolean true — сигнал принят Битрикс24

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

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

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

400 — неизвестный тип сущности:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_ENTITY_TYPE",
    "message": "Unknown entityType \"banana\". Supported: deal, lead, contact, company, quote, invoice, item"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не передан обязательный параметр entityType, entityId или triggerId, либо указан entityType: item без entityTypeId
400 INVALID_ENTITY_TYPE Неизвестный тип сущности. Допустимые: deal, lead, contact, company, quote, invoice, item
400 INVALID_ENTITY_TYPE_ID entityTypeId относится к типу с выделенным entityType — используйте сам тип (deal, lead, contact, company, quote или invoice для entityTypeId=31) вместо item
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 Ключу не хватает скоупа crm
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе
404 ENTITY_NOT_FOUND Битрикс24 не нашёл цель сигнала — entityId некорректен, например нечисловой
429 RATE_LIMITED Превышен лимит запросов. Повторите через 1–2 секунды
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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

  • Сигнал принимается независимо от настройки автоматизации. Если для переданного triggerId на данном шаге воронки не настроены роботы, Битрикс24 всё равно возвращает data: true — ошибки не возникает.
  • Существование сущности не проверяется. Корректный числовой entityId принимается, даже если записи с таким ID нет — fire возвращает data: true, не проверяя получателя сигнала. Передавайте entityId из источников, указанных в полях запроса.

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