Информация об отправленном клиенту сообщении записывается send_message_id.

Параметр имеет вид: 5a9bf01a17_3cd_11_6f_0_2.5a8c045fc1dde44cbf718f78

Часть слева от . состоит из hex чисел

  • 5a9bf01a UTC Timestamp времени отправки сообщения
  • 17 - ID аккаунта
  • 3cd - ID кампании
  • 11 - ID сообщения
  • 6f - ID базы данных
  • - ID сегмента
  • - ID сендера

Часть справа от . это ID профиля в базе данных 5a8c045fc1dde44cbf718f78.


Для всех типов событий:

Общая структура hook-сообщения
ПараметрТипПримерОписание
event_typestringclickНазвание события как в таблице типы событий.
event_datestring2018-03-04T13:13:19.034315796ZДата возникновения события в формате ISO-8601.
_xxhstringad1850e0d1d9481eХеш от email подписчика, используемый для идентификации в ALTCRAFT.
_md5string145bb30f7ddf1184cb560bc4b7705646MD5 хеш от email подписчика.
list_idint111ID Базы данных (листа), в рамках которого возникло событие.
account_idint23ID Аккаунта, в рамках которого возникло событие.
is_testboolfalseБыло ли событие вызвано тестовой отправкой сообщения.
custom_dataJSON object
{"email": "alice@example.org"}
Набор данных о подписчике, настраиваемый в интерфейсе редактирования Action Hook.
event_data JSON object
{"browser": "Firefox"}
Набор данных, зависящий от типа события (есть два типа - событие в трекинге и возникающее в процессе доставки).


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

  • uopen, open, uclick, click, confirm, confirmsub, unsub, read, glanced, skimmed,
  • uclick_sms, click_sms, uclick_sms,
  • uopen_push, open_push, click_push, uclick_push.
Структура event_data для событий, возникающих в системе трекинга
ПараметрТипПримерОписание
message_idint17ID сообщения в системе ALTCRAFT
campaign_idint973ID кампании в системе ALTCRAFT
segment_idint0ID сегмента, если доступно
resource_idint3ID ресурса
ipstring10.9.0.14IPv4 адрес подписчика
countrystring
Страна в TLD виде
citystring
Город подписчика
postal_codestring
Почтовый код подписчика
regionstring
Регион подписчика
tzstringEurope/VaduzВременная зона подписчика
latfloat
Географическая широта
lonfloat
Географическая долгота
user_agentstringMozilla/5.0 (X11; Linux x86_64; rv:59.0) Gecko/20100101 Firefox/59.0Строка в заголовке User-Agent
osstringLinux x86_64Операционная система
browserstringFirefoxБраузер, версия
devicestringwebУстройство
link_urlstringhttp://www.example.comHTTP ссылка, на которую был осуществлен редирект
launch_idstring00000017000003cd5a9bf01aID запуска. Состоит из трёх hex чисел:
ID Аккаунта - 00000017
ID кампании - 000003cd
UTC Timestamp времени отправки - 5a9bf01a
send_message_idstring5a9bf01a17_3cd_11_6f_0_2.5a8c045fc1dde44cbf718f78ID отправленного сообщения

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

  • send, deliv, undeliv, suppress, sbounce, hbounce, complain,
  • send_sms, deliv_sms, undeliv_sms,
  • send_push, deliv_push.
Структура event_data для событий, возникающих в процессе отправки сообщений
ПараметрТипПримерОписание
message_idInteger17ID сообщения в системе ALTCRAFT
campaign_idInteger973ID кампании в системе ALTCRAFT
segment_idInteger0ID сегмента, если доступно
resource_idInteger3ID ресурса в системе ALTCRAFT
bounce_codeInteger500Код ответа от мейл сервера для событий sbounce, hbounce
bounce_messageStringNo such emailОтвет от мейл сервера, для событий sbounce, hbounce
launch_idString00000017000003cd5a9bf01aID запуска. Состоит из трёх hex чисел:
ID Аккаунта - 00000017
ID кампании - 000003cd
UTC Timestamp времени отправки - 5a9bf01a
send_message_idString5a9bf01a17_3cd_11_6f_0_2.5a8c045fc1dde44cbf718f78ID отправленного сообщения


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

Структура event_data для событий пикселей
ПараметрТипПримерОписание
ipstring10.9.0.14IPv4 адрес подписчика
countrystring
Страна в TLD виде
citystring
Город подписчика
pixel_idint41ID пикселя
postal_codestring
Почтовый код подписчика
regionstring
Регион подписчика
tzstringEurope/VaduzВременная зона подписчика
latfloat
Географическая широта
lonfloat
Географическая долгота
user_agentstringMozilla/5.0 (X11; Linux x86_64; rv:59.0) Gecko/20100101 Firefox/59.0Строка в заголовке User-Agent
osstringLinux x86_64Операционная система
browserstringFirefoxБраузер, версия
devicestringwebУстройство


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

Структура event_data для событий, связанных с промокодами
ПараметрТипПримерОписание
attachedstring"2020-10-02T13:28:52Z"Дата и время прикрепления промокода к профилю
detachedstring"2020-10-02T13:28:52Z"Дата и время отсоединения промокода
activatedstring"2020-10-02T13:28:52Z"Дата активации промокода
codestring"TEST-XOUH-KBJM-J5K9-24I1"Промокод
db_idint123456Идентификатор базы профиля
loyalty_idint9Идентификатор программы лояльности
profile_idstring"000000000000000000000000"Идентификатор профиля


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

Структура event_data для событий, связанных с автоматических созданием статического сегмента при импорте
ПараметрТипПримерОписание
campaign_idint9ID кампании в системе ALTCRAFT
launch_idstring""ID запуска. Состоит из трёх hex чисел:
ID Аккаунта - 00000017
ID кампании - 000003cd
UTC Timestamp времени отправки - 5a9bf01a
message_idint0ID сообщения в системе ALTCRAFT
segment_idint80ID сегмента, если доступно
send_message_idstring""ID отправленного сообщения

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

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

Если происходит объединение профилей, то содержит данные матчинга профиля, который получится в результате объединения


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

sourcearray

[
   {
       "custom_data": {
            "age": 25
        },
        "db_id": 94,
        "profile_id": "608a8960e3224a6be26a71df"
   }
]

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


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


Для событий типа 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:

Структура event_data для событий Telegram Bot и Telegram Group каналов
ПараметрТипПримерОписание
campaign_idint9ID кампании в системе ALTCRAFT
launch_idstring""ID запуска. Состоит из трёх hex чисел:
ID Аккаунта - 00000017
ID кампании - 000003cd
UTC Timestamp времени отправки - 5a9bf01a
message_idint0ID сообщения в системе ALTCRAFT
resource_idint3ID ресурса в системе ALTCRAFT
segment_idint80ID сегмента, если доступно
send_message_idstring""ID отправленного сообщения


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

Общая структура события campaign_launch
ПараметрТипПримерОписание
event_typestringcampaign_launchТип события
event_datestring2018-03-04T13:13:19.034315796ZДата события в формате ISO-8601
account_idint23ID аккаунта платформы
is_testboolfalseПризнак тестовой отправки события
event_dataJSON object{}

Объект с данными о кампании

Структура event_data для campaign_launch
ПараметрТипПримерОписание
campaign_idint42Идентификатор кампании
campaign_typestringbroadcastТип кампании
campaign_namestringnameНазвание кампании
campaign_sub_idstringx11
data_typestringsegmentТип источника данных
data_idint3Идентификатор источника данных
launch_idstring00000017000003cd5a9bf01aID запуска. Состоит из трёх hex чисел:
ID Аккаунта - 00000017
ID кампании - 000003cd
UTC Timestamp времени отправки - 5a9bf01a
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}!"
      }
    ]
  }
}
  • No labels