Активировать триггер — Автоматизация

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

POST /v1/triggers/fire

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

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

Поле	Тип	Обяз.	Описание
`entityType`	string	★	Тип CRM-сущности: `deal`, `lead`, `contact`, `company`, `quote`, `invoice`
`entityId`	number	★	ID CRM-сущности. Источник: `GET /v1/deals`, `GET /v1/leads`, `GET /v1/contacts`, `GET /v1/companies`, `GET /v1/quotes`, `GET /v1/invoices`
`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

#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 — неизвестный тип сущности: