Работа с событиями

Событие — это сигнал о действии клиента, который приходит с вашего сайта, из приложения или из другой системы. Например: посещение сайта, добавление товара в корзину, брошенная корзина, открытие письма или сообщения в мессенджере.

Раздел «События» доступен на тарифе Expert и выше. В одном кабинете можно создать не больше 10 событий.

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

Как создать событие

1. Откройте раздел «События» и нажмите «Создать событие».
2. Укажите ключ. Это имя события для API, например cart_abandoned.
3. При необходимости добавьте комментарий, чтобы в кабинете было понятно, что означает событие.
4. Сохраните событие.

Ключ должен быть уникальным в кабинете, начинаться с латинской буквы и содержать только латинские буквы, цифры и символ _. Пробелы не допускаются. После создания ключ изменить нельзя. Комментарий можно изменить позже.

Как отправить событие

Событие принимается только если его ключ уже создан в кабинете. Запрос отправляется методом POST на адрес https://core.cardpr.com/api/v2/crm/event/send.

В теле запроса передайте:

• app_key — приватный ключ из раздела «Настройки → API»;
• ровно один идентификатор клиента: phone, card или remoteId;
• event — ключ события;
• value — необязательная строка до 100 символов, например этап или название товара.

{
  "app_key": "приватный ключ",
  "phone": "+79990000000",
  "event": "cart_abandoned",
  "value": "checkout"
}

Вместо телефона можно передать номер карты в поле card или идентификатор клиента в CRM в поле remoteId. Несколько идентификаторов в одном запросе указывать не нужно: подойдёт только один.

Проверить событие можно и без своей интеграции. В списке событий откройте тест, укажите телефон, номер карты или remoteId и при необходимости value. Успешная отправка попадёт в историю клиента.

На запросы действуют лимиты API кабинета. Их можно посмотреть в разделе «Настройки → API».

Где смотреть результат

Откройте карточку клиента и вкладку истории событий. В таблице будут ключ, значение, источник и дата. События, отправленные из кабинета, и события, отправленные по API, попадают в одну историю.