1. Режим "лид"
# Запрос со всей информацией о лиде
# Пример отправляемых данных
URI:
адрес веб-ресурса, указанный в Alfa-Track
Method:
POST
Request header:
Content-Type: application/json
Request body:
{
"subject":"Компрессорные станции",
"ga:city":"Noginsk",
"lastDirectSearchPhrase":null,
"ga:deviceCategory":"desktop",
"ymCid":"1542029191745252331",
"outHitId":null,
"ga:medium":"organic",
"attachmentsUrl":"https://files...",
"id":243467112,
"email":"tmz@mail.ru",
"ga:fullReferrer":"google",
"ga:country":"Russia",
"clientId":"170399450.1542029190",
"outSessionId":null,
"ga:pagePath":"/stanciya/kompr/",
"ip":"88.84.223.202",
"outVisitorId":null,
"message":" \nДобрый день!",
"ga:socialNetwork":"(not set)",
"ga:adContent":"(not set)",
"ga:source":"google",
"ga:campaign":"(not set)",
"ga:sessionCount":"1",
"ga:browser":"Chrome",
"sendDay":"2021-01-15 09:47:57",
"name":"OOO MZ",
"alfatrackId":"277938",
"ga:keyword":"(not provided)",
"ga:dateHourMinute":"201811121626",
"msgRealId":"loсal.2342.gis@cafs.ru",
"analyticSystem":"GOOGLE_ANALYTICS",
"alias":"zakaz1@gsk.ru",
"attributionModel":"FIRST_CLICK",
"customId":"344590350",
}
Данный режим работы вебхука является режимом по умолчанию и подразумевает отправку одного запроса спустя некоторое время после наступления события. Данное время требуется для получения детальной информации по идентификации посещений сайта новым клиентом и может занимать до трех часов.
ОПИСАНИЕ ПАРАМЕТРОВ
| Имя | Описание |
|---|---|
| name | Имя адресата(лида, включает ФИО, если доступно) |
| clientId | Идентификатор посетителя в Google Аналитике |
| id | Идентификатор обращения в Alfa-Track |
| msgRealId | Идентификатор письма в почтовом ящике(при наличии) |
| ymcid | Идентификатор посетителя в Яндекс.Метрике |
| sendDay | Дата отправки письма/запроса через форму обратной связи |
| Емеил адрес лида(обязательный) | |
| subject | Тема письма/обращения |
| message | Текст письма/обращения |
| ip | IP адрес посетителя сайта |
| ga:source | Значение utm_source или источник, установленный не через get параметр(например из связи Ads+GA) |
| ga:medium | Значение utm_medium или тип трафика, установленный не через get параметр(например из связи Ads+GA) |
| ga:campaign | Значение utm_campaign или кампания, установленная не через get параметр(например из связи Ads+GA) |
| ga:keyword | Значение utm_keyword или ключевое слово, которое инициировало показ объявления, установленное не через get параметр(например из связи Ads+GA) |
| ga:socialNetwork | Социальная сеть, из которой перешел посетитель |
| ga:adContent | Значение utm_content или содержание, которое инициировало показ объявления, установленное не через get параметр(например из связи Ads+GA) |
| ga:fullReferrer | Адрес веб-сайта, из которого перешел посетитель |
| ga:city | Город посетителя |
| ga:dateHourMinute | Дата посещения в формате ГГГГММДДЧЧММ |
| ga:sessionCount | Идентификатор сессии посетителя |
| outVisitorId | Идентификатор посетителя от системы веб-аналитики, с которой произведена интеграция, например CallTouch,Comagic |
| outSessionId | Идентификатор сессии посетителя от системы веб-аналитики, с которой произведена интеграция, например CallTouch,Comagic |
| outHitId | Идентификатор запроса от системы веб-аналитики, с которой произведена интеграция, например CallTouch,Comagic |
| lastDirectSearchPhrase | Поисковый запрос одной из поисковых систем |
| ga:browser | Браузер посетителя |
| ga:country | Страна посетителя |
| ga:deviceCategory | Устройство посетителя |
| ga:pagePath | Страница, на которой находился посетитель |
| attachmentsUrl | Ссылка для загрузки вложения |
| id | Идентификатор обращения в системе Alfa-Track |
| msgRealId | Идентификатор письма, заданный отправителем |
| analyticSystem | Ссылка для загрузки вложения |
| alias | Адрес подменной почты, если еиспользуется технология подмены Alias |
| attributionModel | модель атрибуции, может быть: FIRST_INTERACTION (первое взаимодействие); LAST_INTERACTION (последнее взаимодействие); LAST_NON_DIRECT_CLICK (последний не прямой клик); LAST_PAID_CLICK (последний платный клик); |
| customId | Пользовательский идентификатор посетителя, заданный с помощью JS API |
2. Режим "создание и обновление лида"
# Запрос на создание лида
# Пример отправляемых данных
URI:
адрес веб-ресурса, указанный в Alfa-Track
Method:
POST
Request header:
Content-Type: application/json
Request body:
{
"ymCid":null,
"clientId":null,
"sendDay":"2021-01-15 10:16:22",
"subject":"Задвижка...",
"name":"Арман Сергазин",
"attachmentsUrl":"https://files...",
"alfatrackId":"zakaz339@ks-r.com",
"id":850680654,
"message":"Уважаемый...",
"email":"zakukus@gmail.com",
"customId":"3458344535"
}
# Запрос со всей информацией о лиде
идентичный запросу из режима лид
Данный режим работы подразумевает отправку двух запросов. Первый запрос отправляется, как только происходит событие. Как и в режиме "лид" событием является обращение нового клиента - лида(согласно настройкам Alfa-Track) в компанию.
В случае, если все данные будут доступны в момент события, отправиться только один запрос.
ОПИСАНИЕ ПАРАМЕТРОВ
| Имя | Описание |
|---|---|
| name | Имя адресата(лида, включает ФИО, если доступно) |
| clientId | Идентификатор посетителя в Google Аналитике |
| id | Идентификатор обращения в Alfa-Track |
| msgRealId | Идентификатор письма в почтовом ящике(при наличии) |
| ymcid | Идентификатор посетителя в Яндекс.Метрике |
| sendDay | Дата отправки письма/запроса через форму обратной связи |
| Емеил адрес лида(обязательный) | |
| subject | Тема письма/обращения |
| message | Текст письма/обращения |
| attachmentsUrl | Ссылка для загрузки вложения |
| customId | Пользовательский идентификатор посетителя, заданный с помощью JS API |
Ошибки передачи данных
В случае если веб-ресурс не отвечает статус кодом 200 по какой либо причине, система Alfa-Track будет производить попытки повторной отправки запроса на протяжении трех часов после события с интервалом 5 минут.
Лимиты и ограничения
В рамках одного Alfa-Track проекта можно подключить только 1 вебхук.