Перейти к основному содержимому
Altcraft Docs LogoAltcraft Docs Logo
Пользователям iconПользователям
Разработчикам iconРазработчикам
Администраторам iconАдминистраторам
Русский
  • Русский
  • English
Войти
    Документация пользователяС чего начатьFAQТермины
      Обновления платформыarrow
    • v2026.1.76v2025.4.75v2025.4.74v2025.3.73v2025.2.72v2025.1.71v2024.4.70v2024.3.69v2024.2.68.2v2024.1.68
      Хранение и сбор данныхarrow
    • Ресурсы подписокРабота с базами данныхПрофиль подписчикаИмпорт профилей клиентов и обновление данныхИмпорт данных по расписаниюАвтоматизация сбора данных о профилеМассовое обновление профилей клиентовDouble opt-in подпискаСтоп-спискиСвязи между профилямиЭкспорт истории профилейЭкспорт профилейАвтоматическое создание статического сегмента при импортеКак открыть CSV-файлМатчингТипы полей в базе данныхГлобальные контрольные группыМенеджер подписок
      Каналы коммуникацииarrow
      • Emailarrow
        • Рассылка с нуляarrow
        • Быстрый стартПервая Email-рассылка
        Рекомендации по взаимодействию с ISPНастройка собственного from-доменаНастройка и использование постмастеров
        Pusharrow
        • Mobile Pusharrow
        • Первая Mobile push-рассылкаНастройка и подключение
            Интеграция приложения с Altcraftarrow
          • Провайдеры: структура push сообщенияОбработка и добавление подпискиРегистрация событий
          Web Pusharrow
        • Первая Web push-рассылкаПредварительные настройки
            Настройка для различных браузеровarrow
          • Apple SafariMozilla ServicesFirebase Cloud Messaging
          Подключение Web Push на сайтПередача данных в платформуМетоды Web Push SDK
            Миграция и перенос подписокarrow
          • Перенос push-подписок из стороннего сервисаКак перенести push-подписки, настроенные для SafariМиграция с OneSignal
        SMSarrow
      • Первая SMS-рассылка
        Telegramarrow
      • Telegram BotTelegram Group
        Maxarrow
      • MAX BotMAX Group
      Viber™WhatsAppNotifyСхема работы каналов коммуникацииРуководство: SMS-рассылка через VK NotifyРуководство: SMS-рассылка через УТШРуководство: push-рассылка через сервис от "Согласие"
      Сегментацияarrow
    • Статические сегментыДинамические сегментыОбновляемые сегменты
        Условия сегментацииarrow
      • Сегментация по данным профиляСегментация по взаимодействиям с сущностямиСегментация по активности в каналах коммуникацииСегментация по внешним даннымСегментация по внешним SQL-таблицамСегментация по структуре профиля
      Лучшее время отправки (BST)Логические операторы "И" и "ИЛИ"Рекомендации по работе с сегментами
      Шаблоны сообщенийarrow
      • Работа с шаблонами сообщенийarrow
      • Работа в редактореEmail-шаблонSMS-шаблонPush-шаблонMAX-шаблонTelegram-шаблонWhatsApp-шаблонViber™-шаблонNotify-шаблон
        Визуальный редактор для email-шаблонаarrow
      • Интерфейс редактораДобавление элементовЭлементы и их настройкиПользовательские блокиСтили элементаСтруктура элементов
      Блочный редактор для email-шаблонаФрагменты шаблоновИзображения в сообщенияхПерсонализация контента в сообщенияхФормирование таблиц на основе элементов массива
        Переменные и функции Altcraftarrow
      • Использование логических выражений в сообщенияхИспользование циклов в сообщенияхИспользование переменных маркета в сообщенияхИспользование функционала JSONPath
        Динамический контент сообщенийarrow
      • Использование API-контента в сообщенияхИспользование HTML-контента в сообщенияхИспользование JSON-контента в сообщенияхИспользование контента из SQL базы данных в сообщениях
      Импорт и экспорт шаблона сообщенияЭкспорт шаблона из PixcraftИмпорт шаблона из стороннего сервиса
      Рассылкиarrow
    • Календарь рассылокБроадкаст рассылкаРегулярная рассылкаТриггерная рассылкаМультивариантный тест (A/B/n)Тестирование расылокРасписание рассылокРазмещения
      Кампанииarrow
    • Работа с КампаниямиЛокальные контрольные группы (ЛКГ)Ошибка нарушения стратификации при достижении лимитаРасширение аудитории в кампанииРазметка аудитории в кампаниях
      Сценарии автоматизацииarrow
    • Работа со Сценариями автоматизацииУзлы сценарияКлассические сценарии автоматизации маркетингаПриветственный сценарий: пошаговая настройкаАвтоматическое оповещение менеджера через сценарийСценарий брошенной корзины
      Маркетarrow
    • Настройки маркета
        Продуктыarrow
      • Создание продукта вручнуюИмпорт продукта из файлаИмпорт по расписаниюСегменты продуктов и SKUПодготовка YML-файла
      ЗаказыПеременные маркета в шаблонахРуководство: как отправить письмо подтверждения заказа
      Лояльностьarrow
    • Создание и настройка программы лояльностиИнтеграция лояльности с внешними системамиБыстрый стартБазовые кейсы использования программы лояльностиСегменты заказовПромокоды
      Веб-слойarrow
      • Формыarrow
        • Создание формыarrow
        • Основные настройки формыКонструктор формыОформление формыДействия и публикация формыУсловная постраничная логика в формах и опросах
        Аналитика данныхСвязывание данных канала и формыNPS-тестирование
        Пикселиarrow
      • Целевые действия клиентов и скоринг
        Попапыarrow
      • Создание и публикация попапаНастройка попапа в редакторе кодаУправление попапами вручную через скриптАналитика попаповРуководство: попап для подписки на pushБазовые кейсы размещения попапа через Менеджер теговКейс: Создание попапа с виджетом "Колесо фортуны"
        Менеджер теговarrow
      • Настройка и установка Менеджера теговТипы триггеровТипы переменныхСвязывание пикселя и Менеджера тегов
      Отчеты и аналитикаarrow
    • Отчет по каналамОтчёт по трафику
        Сводный отчётarrow
      • Все показатели сводного отчета
      Когортный отчётВремя жизниВоронка конверсииЦелиПрирост аудиторииКарта кликов (Email)Отчет по программам лояльностиОтчёт о возвратахОтчёт о недоставкахОтчет по глобальным контрольным группам
      Интеграцииarrow
    • Синхронизация статических сегментовMAXЯндекс.Аудитории™Аудитории Google AdsFacebook Ads Manager™Область видимости интеграцииWhatsAppViber™Tilda™Yandex AppMetrica™Lpgenerator™VK Реклама™Передаваемые при синхронизации данные
        Интеграция сторонних сервисов с Altcraft через Albatoarrow
      • Подключение Altcraft к AlbatoЗапуск приветственного сценария через AlbatoПередача данных о событииОтправка триггерной рассылкиРегистрация событийИмпорт данных из Google Sheets через AlbatoПередача данных из Altcraft
      Notify
        Захват событийarrow
      • Захват событий AltcraftТипы событий для захватаСтруктуры сообщений захвата событийОтправить JSON-запрос батчемОтправить сообщение в очередь RabbitMQОтправить сообщение в exchange RabbitMQОтправить сообщение в Kafka brokerПредварительное тестирование события
      Настройкиarrow
    • Настройки аккаунтаНастройки атрибутовПоисковые теги: создание и применениеПользовательские ссылкиВиртуальные сендерыПолитики отправки
        Пользователи и разграничение доступаarrow
      • Двухфакторная аутентификация (2FA)
        Подключенияarrow
      • Подключение к Facebook AdsПодключение к Google AdsПодключение к Яндекс.Аудиториям™Подключение к 360dialogПодключение к EdnaПодключение к Devino TelecomПодключение к SMS TrafficПодключение к VK Рекламе™Подключение к MTS OmniChannelПодключение через OAuth2Подключение через Basic AuthenticationПодключение через Token AuthenticationПодключение через Custom AuthenticationПодключение к MAXПодключение к NotifyПодключение к Rapporto
      Журнал аудита
      API-запросы: с чего начатьarrow
    • Импорт и обновление профиляЗапуск триггерной рассылкиОтправка профиля клиента в сценарий
    Архив документацииБиблиотека email-маркетолога
  • Интеграции
  • Захват событий
  • Структуры сообщений захвата событий

Структуры сообщений захвата событий

Общая структура​

Общая структура hook-сообщения для большинства типов событий:

ПараметрТипОбязательныйПримерОписание
event_typestringДа"click"Название события как в таблице типы событий
event_datestringДа"2018-03-04T13:13:19.034315796Z"Дата возникновения события в формате RFC 3339
profile_idstringНет"abcdefgh12345678"ID профиля получателя
_xxhstringНет"ad1850e0d1d9481e"Хеш от email подписчика, используемый для идентификации в Altcraft
_md5stringНет"145bb30f7ddf1184cb560bc4b7705646"MD5 хеш от email подписчика
list_idintНет111ID Базы данных, в рамках которого возникло событие
account_idintДа23ID Аккаунта, в рамках которого возникло событие
sends_trying_numintНет2Число попыток отправки сообщения (присутствует, только если количество попыток больше 0)
is_testboolДаfalseБыло ли событие вызвано тестовой отправкой сообщения
is_staticboolНетfalseИспользовались ли динамические подстановки в отправляемый контент
subscription_hash_idstringНет"0a4b910312345"Хеш подписки
custom_dataJSON objectНет
{"alice@example.org"}
Набор данных о подписчике, настраиваемый в интерфейсе редактирования Action Hook
event_dataJSON objectДа
{"browser": "Firefox"}
Набор данных, зависящий от типа события (есть два типа — событие в трекинге и возникающее в процессе доставки)
subscriptionarrayНет
[
  {
    "resource_id": 123,
    "channel": "email",
    "email": "user@example.com",
    "phone": "+79991234567",
    "subscription_id": "abc123",
    "provider": "androidfirebase",
    "priority": 1,
    "status": "subscribed",
    "ccsub": {
      "custom_key": "custom_value"
    }
  }
]
Массив с деталями подписки, включающий информацию о ресурсе, канале связи, получателе и статусе подписки. Структура описана ниже.
Обратите внимание

При экспорте исторических событий контент сообщений не передается, события отправляются тем же форматом, что и в реальном времени, а для удаленных профилей передается null.

Структура event_data​

События аудитории кампании​

Для событий типа audience:

ПараметрТипОбязательныйПримерОписание
scampaign_idintНет1ID кампании в Altcraft
prev_stintНет1Идентификатор группы: 1 — тестовая, 2 — ЛКГ

События системы трекинга​

Для событий следующих типов:

  • Email: uopen, open, uclick, click, confirm, confirmsub, unsub, read, glanced, skimmed
  • SMS: uclick_sms, click_sms, unsub_sms
  • Push: uopen_push, open_push, click_push, uclick_push
ПараметрТипОбязательныйПримерДля какого каналаОписание
message_idintДа17Email, SMS, PushID сообщения в системе Altcraft
campaign_idintДа973Email, SMS, PushID рассылки в системе Altcraft
scampaign_idintНет973Для всехID кампании в системе Altcraft
segment_idintНет0Email, SMS, PushID сегмента, если доступно
resource_idintДа3Email, SMS, PushID ресурса
ipstringНет"10.9.0.14"Email, PushIPv4 адрес подписчика
countrystringНет".us"
".ru"
Email, PushСтрана в TLD виде
citystringНет"New York"
"Moscow"
Email, PushГород подписчика
postal_codestringНет"101000"Email, PushПочтовый код подписчика
regionstringНет"Ohio"
"Moskovskaya oblast"
Email, PushРегион подписчика
tzstringНет"Europe/Vaduz"Email, PushВременная зона подписчика
latfloatНет55.244075Email, PushГеографическая широта
lonfloatНет55.244075Email, PushГеографическая долгота
user_agentstringНет"Mozilla/5.0 (X11; Linux x86_64; rv:59.0) Gecko/20100101 Firefox/59.0"Email, PushСтрока в заголовке User-Agent
osstringНет"Linux x86_64"Email, PushОперационная система
browserstringНет"Firefox"Email, PushБраузер, версия
devicestringНет"web"Email, PushУстройство
wickintНет1Email, PushИсточник события, если 1 - API
link_urlstringНет"http://www.example.com"Email, SMS, PushHTTP ссылка, на которую был осуществлен редирект
launch_idstringДа"00000017000003cd5a9bf01a"Email, SMS, PushID запуска
send_message_idstringДа"5a9bf01a17_3cd_11_6f_0_2.5a8c045fc1dde44cbf718f78"Email, SMS, PushID отправленного сообщения
full_message_idstringДа"fQIQs4FgAAEBIcARADkxODlKR8-gA"Email, SMS, PushПолный SendMessageID
email_message_idstringНет"mzi5c1~+9vqekqmy63mh8xhgt2qjwfkad6lmiafbyn-0te1_uzckfqyi4ry"EmailEmail-safe SendMessageID
extra_uidstringНет"ew4Sgf41Qwjq8_2_2E_w_k___t.2SDvJv8b1DXc7Z_D"PushExtra UID
providerstringНет"YandexAppMetricaDeviceIDAndroid"PushПровайдер
prev_stintНет1Для всехИдентификатор группы: 1 - тестовая, 2 - ЛКГ

События отправки в очередь​

Для событий следующих типов:

  • Email: send, deliv, suppress, complain
  • SMS: send_sms, deliv_sms
  • Push: send_push, deliv_push
ПараметрТипОбязательныйПримерДля какого каналаОписание
message_idintДа17Email, SMS, PushID сообщения в системе Altcraft
campaign_idintДа973Email, SMS, PushID рассылки в системе Altcraft
segment_idintНет0Email, SMS, PushID сегмента, если доступно
resource_idintДа3Email, SMS, PushID ресурса в системе Altcraft
launch_idstringДа"00000017000003cd5a9bf01a"Email, SMS, PushID запуска
send_message_idstringДа"5a9bf01a17_3cd_11_6f_0_2.5a8c045fc1dde44cbf718f78"Email, SMS, PushID отправленного сообщения
full_message_idstringДа"fQIQs4FgAAEBIcARADkxODlKR8-gA"Email, SMS, PushПолный SendMessageID
email_message_idstringНет"mzi5c1~+9vqekqmy63mh8xhgt2qjwfkad6lmiafbyn-0te1_uzckfqyi4ry"EmailEmail-safe SendMessageID
extra_uidstringНет"ew4Sgf41Qwjq8_2_2E_w_k___t.2SE_4Sgf41DXc7Z_D"PushExtra UID
providerstringНет"YandexAppMetricaDeviceIDAndroid"PushПровайдер
workflow_idintНет1Для всехID сценария, если рассылка запускалась из сценария

Для событий sbounce, hbounce, sbounce_push, hbounce_push также передаются следующие параметры:

ПараметрТипОбязательныйПримерДля какого каналаОписание
bounce_codeintДа500Email, PushКод ответа от сервера
bounce_messagestringДа"No such email"Email, PushОтвет от сервера

Для событий undeliv, undeliv_sms, undeliv_push передаются следующие параметры:

ПараметрТипОбязательныйПримерДля какого каналаОписание
undeliv_codeintДа400Email, SMS, PushКод ошибки
undeliv_messagestringДа"Invalid Caller ID"Email, SMS, PushСообщение об ошибке

События пикселей​

Для событий типа pixel_open:

ПараметрТипОбязательныйПримерОписание
ipstringДа"10.9.0.14"IPv4 адрес подписчика
countrystringДа".ru "Страна в TLD виде
citystringДа"Moscow"Город подписчика
pixel_idintДа41ID пикселя
postal_codestringДа"390000"Почтовый код подписчика
regionstringДа"Ryazanskaya obl"astРегион подписчика
tzstringДа"Europe/Vaduz"Временная зона подписчика
latfloatДа55.244075Географическая широта
lonfloatДа55.244075Географическая долгота
user_agentstringДа"Mozilla/5.0 (X11; Linux x86_64; rv:59.0) Gecko/20100101 Firefox/59.0"Строка в заголовке User-Agent
osstringДа"Linux x86_64"Операционная система
browserstringДа"Firefox"Браузер, версия
devicestringДа"web"Устройство

Полный список возможных параметров указан в этой статье.

События попапов​

Для всех событий типа popup_post, popup_click, popup_error, popup_bounce, popup_close, popup_open:

ПараметрТипОбязательныйПримерОписание
popup_idintДа123ID попапа
refererstringДа"api.example.com"Заголовок запроса Referer
smidstringДа"fGmXiWU9Y4NSIpCwl4QQQQEQEAABCRA"Идентификатор отправляемого сообщения
utm_campaignstringНет"utm_campaign"UTM-метка рассылки
utm_contentstringНет"utm_content"UTM-метка контента
utm_sourcestringНет"utm_source"UTM-метка источника

У некоторых событий есть свои уникальные параметры:

ПараметрТипОбязательныйПримерОписание
popup_post
post_uidstringДа"7bc142b5-7f38-4272-bc7e-7539f70b25b1"Уникальный идентификатор заполнения формы
popup_click
namestringДа"main_block"Название элемента, по которому был совершен клик
urlstringДа"example.com/page"Значение атрибута href элемента, по которому был совершен клик
popup_error, popup_bounce
errorstringДа"object_not_found"Текст ошибки
error_categoryintДа404Номер ошибки

События промокодов​

Для событий типа promocode_attach, promocode_detach, promocode_activate:

ПараметрТипОбязательныйПримерОписание
attachedstringДа"2020-10-25T13:28:52Z"Дата и время прикрепления промокода к профилю
detachedstringДа"2020-10-25T13:28:52Z"Дата и время отсоединения промокода
activatedstringДа"2020-10-25T13:28:52Z"Дата активации промокода
codestringДа"TEST-XOUH-KBJM-J5K9-24I1"Промокод
db_idintДа123456Идентификатор базы профиля
loyalty_idintДа9Идентификатор программы лояльности
profile_idstringДа"000000000000000000000000"Идентификатор профиля

Все даты указываются в формате RFC 3339.

События создания сегмента при импорте​

Для событий типа segs_add, segs_remove:

ПараметрТипОбязательныйПримерОписание
campaign_idintДа9ID рассылки в системе Altcraft
launch_idstringДа""ID запуска рассылки
message_idintДа0ID сообщения в системе Altcraft
segment_idintДа80ID сегмента, если доступно
send_message_idstringДа""ID отправленного сообщения
full_message_idstringДа"fQIQs4FgAAEBIcARADkxODlKR8-gA"Полный SendMessageID

События объединения нескольких профилей или разделения одного профиля​

Для событий типа profile_merge, profile_split:

ПараметрТипОбязательныйПримерОписание
destinationarrayДа
[
   {
      "custom_data": {
         "age": 25
      },
      "db_id": 94,
      "profile_id": "608a8960e3224a6be26a71df"
   }
]
Если происходит объединение профилей, то содержит данные матчинга профиля, который получится в результате объединения.


Если происходит разделение профиля, то содержит данные матчинга профилей, которые получатся в результате разделения.
sourcearrayДа
[
   {
      "custom_data": {
         "age": 25
      },
      "db_id": 94,
      "profile_id": "608a8960e3224a6be26a71df"
   }
]
При объединении профилей содержит данные матчинга о профилях, которые нужно объединить.


При разделении профиля содержит данные матчинга о профиле, который нужно разделить.

События каналов​

Для событий следующих каналов:

  • Telegram: telegram_bot_send, telegram_bot_deliv, telegram_bot_click, telegram_bot_uclick, telegram_bot_undeliv, telegram_group_send, telegram_group_deliv, telegram_group_click, telegram_group_undeliv
  • MAX: max_bot_send, max_bot_deliv, max_bot_click, max_bot_uclick, max_bot_undeliv, max_group_send, max_group_deliv, max_group_click, max_group_undeliv
  • WhatsApp: whatsapp_deliv, whatsapp_undeliv, whatsapp_send, whatsapp_click, whatsapp_uclick, whatsapp_subscribe, whatsapp_read, whatsapp_unsub
  • Viber: viber_deliv, viber_undeliv, viber_send, viber_click, viber_uclick, viber_subscribe, viber_read, viber_unsub, viber_complain
  • Notify: notify_deliv, notify_undeliv, notify_send, notify_click, notify_uclick, notify_subscribe, notify_read, notify_unsub, notify_complain
ПараметрТипОбязательныйПримерОписание
campaign_idintДа9ID рассылки в системе Altcraft
launch_idstringДа""ID запуска рассылки
message_idintДа0ID сообщения в системе Altcraft
resource_idintНет3ID ресурса в системе Altcraft
segment_idintДа80ID сегмента, если доступно
send_message_idstringДа""ID отправленного сообщения
full_message_idstringДа"fQIQs4FgAAEBIcARADkxODlKR8-gA"Полный SendMessageID
citystringНет"Moscow"Город подписчика
browserstringНет"Firefox"Браузер, версия
countrystringНет".ru"Страна в TLD виде
devicestringНет"web"Устройство
ipstringНет"10.9.0.14"IPv4 адрес подписчика
latfloatНет55.244075Географическая широта
link_urlstringНет"http://www.example.com"HTTP ссылка, на которую был осуществлен редирект
lonfloatНет55.244075Географическая долгота
osstringНет"Linux x86_64"Операционная система
postal_codestringНет"390000"Почтовый код подписчика
regionstringНет"Ryazanskaya oblast"Регион подписчика
tzstringНет"Europe/Vaduz"Временная зона подписчика
undeliv_codeintНет500Код ошибки недоставки
undeliv_messagestringНет"Content is required"Информация об ошибке
workflow_idintНет1ID сценария, если рассылка запускалась из сценария

События ошибок рассылки​

Для событий типа camp_error:

ПараметрТипОбязательныйПримерОписание
campaign_idintДа9ID рассылки в системе Altcraft
error_codeintДа500Код ошибки
error_textstringДа"LOG_INTERNAL_ERROR"Текст ошибки
launch_idstringДа""ID запуска
message_idintДа0ID сообщения в системе Altcraft
resource_idintДа3ID ресурса в системе Altcraft
segment_idintДа80ID сегмента, если доступно
send_message_idstringДа""ID отправленного сообщения
full_message_idstringДа"fQIQs4FgAAEBIcARADkxODlKR8-gA"Полный SendMessageID

Структура campaign_launch​

Общая структура campaign_launch:

ПараметрТипОбязательныйПримерОписание
event_typestringДа"campaign_launch"Тип события
event_datestringДа"2018-03-25T13:13:19.034315796Z"Дата события в формате RFC 3339
account_idintНет23ID аккаунта платформы
is_testboolДаfalseПризнак тестовой отправки события
is_staticboolНетtrueИспользовались ли динамические подстановки
is_historicalboolДаfalseЯвляется ли событие историческим
event_dataJSON objectДа{}Объект с данными о рассылке

Структура event_data для campaign_launch​

ПараметрТипОбязательныйПримерОписание
campaign_idintДа42Идентификатор рассылки
workflow_idintНет1ID сценария, если рассылка запускалась из сценария
scampaign_idintНет1ID кампании в системе Altcraft
campaign_sub_idstringДа"x11"Идентификатор статистики
campaign_namestringДа"name"Название рассылки
campaign_typestringДа"broadcast"Тип рассылки
data_typestringДа"segment"Тип источника данных
data_idintДа3Идентификатор источника данных
launch_idstringДа"00000017000003cd5a9bf01a"ID запуска
contentJSON objectДа{}Информация о шаблонах сообщений рассылки

Пример события запуска рассылки​

{
"event_type": "campaign_launch",
"event_date": "2016-12-09T10:11:24.934079204Z",
"is_test": false,
"account_id": 161,
"event_data": {
"campaign_id": 1472,
"campaign_type": "broadcast",
"campaign_name": "Campaugn Launch Hook",
"campaign_sub_id": "x11",
"data_type": "segment",
"data_id": 1221,
"launch_id": "000000a1000005c0584a834c",
"content": [
{
"message_name": "Hello",
"message_id": 1412,
"suppress_id": 271,
"replyto_email": "",
"replyto_name": "",
"text": "текстовая версия письма",
"html": "<html> html версия письма </html>",
"from_name": "",
"from_email": "",
"attach_links": [],
"subject": "Hello, {your_name}!"
},
{
"message_name": "Hi",
"message_id": 1413,
"suppress_id": 272,
"replyto_email": "monty@altcraft.com",
"replyto_name": "Monty",
"text": "текстовая версия письма",
"html": "<html> html версия письма </html>",
"from_name": "",
"from_email": "",
"attach_links": [
{
"name": "text_file.txt",
"url": "http://test.altcraft.com/api/attach/link/text_file.txt?token=eyJh..."
},
{
"name": "picture_file.png",
"url": "http://test.altcraft.com/api/attach/link/picture_file.png?token=eyJh..."
}
],
"subject": "Hi, {your_name}!"
}
]
}
}

Структура subscription​

В этом объекте передается информация о подписке на ресурс, через который произведена отправка.

Обязательные поля

Для структуры subscription обязательными являются следующие поля: resource_id, channel, priority, status, ccsub.

ПараметрТипПримерОписание
Общие для всех каналов
resource_idint12ID ресурса
channelstring"email"Канал коммуникации
priorityint0Приоритет подписки
statusstring"subscribed"Статус подписки
сс_subJSON object{"custom_key": "custom_value"}Объект с полями подписки пользовательского канала. Если полей нет, то принимает значение null
Для email-канала
emailstring"john@example.com"Email подписчика
Для SMS-канала
phonestring"+79991112233"Номер телефона подписчика
Для push-канала
providerstring"YandexAppMetricaDeviceIDAndroid"Push-провайдер
subscription_idstring"123ab667960efec47b1afe64b56bfa386a3"ID подписки провайдера

Структура content​

Если в настройках вебхука активирована опция "Добавить содержимое сообщений", то в общую структуру hook-сообщения добавляется поле content.

подсказка

Ссылки на веб-версии всегда попадают с хуком, вне зависимости от того, активирована ли опция или нет. Единственное исключение — campaign_launch, для него веб-версий нет.

Для Push и Viber контент не передаётся. Для Telegram контент полностью зависит от шаблона.

Email​

{
"content": {
"amp": "<html amp4email></html>",
"from_email": "no-reply@altcraft.com",
"from_name": "Altcraft",
"html": "<html></html>",
"replyto_email": "example@example.com",
"replyto_name": "Altcraft",
"subject": "Weather alert",
"text": "Text version",
"to_email": "profile@example.com",
"to_name": "Fname Lname",
"webversion_email_html": "http://click.altkraft.com/0000/path.html",
"webversion_email_text": "http://click.altkraft.com/0000/path.txt"
},
}
ПараметрТипОбязательныйПримерОписание
from_emailstringДа"no-reply@altcraft.com"Email отправителя
from_namestringДа"Altcraft"Имя отправителя
htmlstringДаHTML-версия письма
replyto_emailstringДа"example@example.com"Email для обратной связи
replyto_namestringДа"Altcraft"Имя обратного получателя
subjectstringДа"Weather alert"Тема письма
textstringДа"Text version is important..."Текстовая версия письма
to_emailstringДа"profile@example.com"Email адрес профиля получателя
to_namestringДа"Fname Lname"Имя профиля получателя
ampstringНетAMP-версия письма
webversion_email_htmlstringДа"http://click.altkraft.com"Ссылка на web версию письма
webversion_email_textstringДа"http://click.altkraft.com"Ссылка на текстовую веб-версию письма

SMS​

{
"content": {
"fromnamesms": "abcdefghijklmnqrstuvwxyz",
"sms": "Hello, Aaron! See the new items for you: http://click.altkraft.com/s/path",
"webversion_sms_text": "http://click.altkraft.com/000000/path.txt"
}
}
ПараметрТипОбязательныйПримерОписание
fromnamesmsstringДа"abcdefghijklmnqrstuvwxyz"Caller ID
smsstringДа"Переходи по ссылке и забери приветственные бонусы!"Текст сообщения
webversion_sms_textstringДа"http://click.altkraft.com"Ссылка на веб-версию сообщения

WhatsApp​

ПараметрТипОбязательныйПримерОписание
typestringДа"template"Тип сообщения
categorystringДа"marketing"Категория сообщения
namestringДа"welcome"Название шаблона
languagestringДа"ru"Язык шаблона
namespacestringДа"xxx"Namespace шаблона
wa_account_idstringДа"123456"ID аккаунта WhatsApp
componentsarrayДа[...]Компоненты сообщения

MAX​

ПараметрТипОбязательныйПримерОписание
textstringДа"Hello!"Текст сообщения
buttonsarrayДа[...]Кнопки сообщения
disable_link_previewboolДаtrueОтключение предпросмотра ссылок

Push​

{
"content": {
"app_push_settings": {
"background_color": "#00CED1",
"badges": 0,
"banner": "",
"critical_push": false,
"deliver_prior": 0,
"expir_time": 604800,
"led": "",
"media": "",
"silent_push": false,
"sound": "",
"subtitle": "",
"vibro": false
},
"body": "See if our new items are fit to make you even more awesome!",
"click_url": "https://click.altkraft.com/0000000",
"custom_push_json": {},
"icon": "",
"result_content": {
"content_available": true,
"data": {
"hub_link": {
"ack": "https://pxl.altkraft.com/crypto_post_events?/bFOoNcxW7lpDA",
"open": "https://pxl.altkraft.com/crypto_post_events?/LbFOoNcxW7lpDA"
},
"image": "",
"launch_id": "2_3J_4Z2ZTRaQr7p",
"mediaUrl": "",
"message": "See if our new items are fit to make you even more awesome!",
"uid": "fATFSGbgLjinkRE59ZXDOSd0BcAABARnhIxDBBAAAEbAQowRH"
},
"mutable_content": true,
"notification": {
"body": "See if our new items are fit to make you even more awesome!",
"click_action": "https://click.altkraft.com/0000000/abcdefghijklmnqrstuvwxyz",
"color": "",
"icon": "",
"sound": "default"
},
"title": "Just look, Alex! These are awesome!",
"priority": "normal",
"time_to_live": 604800,
"to": "5dbDUxVXHV"
},
"title": "Just look, Alex! These are awesome!",
"webversion_push_body": "http://click.altkraft.com/000000/path.txt"
}
}
ПараметрТипОписание
bodystringТело push-сообщения
click_urlstringСсылка для перехода по клику
custom_push_jsonJSON objectПользовательский JSON сообщения
iconstringПуть до иконки push-сообщения
titlestringЗаголовок сообщения
result_contentJSON objectХранит структуру данных, отправленных в push-сервис
webversion_push_bodystringСсылка на веб-версию push-сообщения
app_push_settingsJSON objectРасширенные настройки для мобильных пушей
web_push_settingsJSON objectРасширенные настройки для браузерных пушей

Структура app_push_settings​

ПараметрТипПримерОписание
background_colorstring#00CED1Цвет фона push-уведомления
badgesint0Индикатор событий
bannerstringhttp://example.com/path.img"Путь к изображению-баннеру
critical_pushboolfalseАктивация критического режима в push-уведомлении
deliver_priorint0,1Приоритет доставки
expir_timeint604800TTL push-уведомления (задается в секундах)
ledstring#00CED2Цвет светодиодного индикатора
mediastringhttp://example.com/pathПуть к локальнoму файлу в приложении
silent_pushboolfalseВключение/отключение тихого режима
soundstring/sound/sound.mp3Путь к локальнoму файлу в приложении
subtitlestring"Только для вас!"Подзаголовок сообщения (для iOS)
vibrobooltrueВибрация при поступлении push-уведомления
soundlessbooltrueУказывает, будет ли push-сообщение сопровождаться звуком (используется провайдерами: android firebase, android huawei, android rustore)
actionsarray
[
   {
  "label": "Открыть",
  "action": "https://example.com"
}
]
Кнопки в push-уведомлениях

Структура web_push_settings​

ПараметрТипПримерОписание
actionsJSON object[]Массив содержит кнопки пуша: ссылка для перехода (action) + текст кнопки (label)
button_labelstring"Конечно"Текст кнопки действия (значение передается только для провайдера Safari)
large_imagestring"https://.altkraft.com/284834790/1/664c6da207767c769a/image.png"Путь к изображению-баннеру
expir_timestring604800TTL push-уведомленния (задается в секундах)
large_imagestring"https://click.example.com"Путь к локальнoму изображению баннера
к сведению

Ссылка на веб-версию сообщения передается в объекте content только для события send в каналах email, sms и push. Для остальных событий, а также для события send в пользовательском канале объект content содержит поле webversion_link с пустой строкой:

"content": {
"webversion_link": ""
}

*Организация Meta, которой принадлежат продукты Instagram, Facebook и WhatsApp, признана экстремистской и запрещена на территории РФ.
**Viber является товарным знаком Rakuten Group, Inc. Заблокирован на территории РФ.

Последнее обновление 30 апр. 2026 г.
Предыдущая страница
Типы событий для захвата
Следующая страница
Отправить JSON-запрос батчем
  • Общая структура
  • Структура event_data
    • События аудитории кампании
    • События системы трекинга
    • События отправки в очередь
    • События пикселей
    • События попапов
    • События промокодов
    • События создания сегмента при импорте
    • События объединения нескольких профилей или разделения одного профиля
    • События каналов
    • События ошибок рассылки
  • Структура campaign_launch
    • Структура event_data для campaign_launch
    • Пример события запуска рассылки
  • Структура subscription
  • Структура content
    • Email
    • SMS
    • WhatsApp
    • MAX
    • Push
      • Структура app_push_settings
      • Структура web_push_settings
© 2015 - 2026 Altcraft. Все права защищены.