Шаблоны
Данная информация относится ко второй версии Webhook API.
Шаблоны определяют структуру и содержимое данных, которые Senler отправляет на ваш сервер в теле HTTP-запроса.
Настройка шаблонов доступна в разделе WebHook API → Шаблоны с помощью визуального конструктора.
.png)
Тело запроса шаблона по умолчанию
Доступные типы данных
При создании шаблона можно использовать следующие типы элементов.
| Тип | Описание |
| Константа | Фиксированное значение, заданное вручную |
| Объект | Группа вложенных полей с произвольными именами |
| Массив | Список элементов |
| Данные подписчика | Одно из предопределённых полей профиля подписчика |
| Пользовательская переменная | Значение переменной, сохранённой для конкретного подписчика |
| Глобальная переменная | Значение одной глобальной переменной канала |
| Идентификатор сообщества ВКонтакте / Telegram | ID сообщества на платформе (для каналов ВКонтакте, Telegram и Макс) |
| Внешний идентификатор платформы | Внешний ID канала на платформе |
| Секретный ключ | Секретный ключ WebHook API канала |
| Информация о событии | Поле из контекста события, вызвавшего отправку вебхука |
| Массив глобальных переменных | Все глобальные переменные канала в виде одного объекта |
Создание шаблона
При создании нового шаблона:
-
Укажите название шаблона.
-
Нажмите Добавить и добавьте необходимые элементы.
.png)
-
Для каждого элемента заполните:
- Тип - выберите один из доступных типов.
- Имя - ключ поля, который будет использоваться в теле запроса.
- Значение - указывается только для типов, которым требуется значение (например, Константа, Данные подписчика, Пользовательская переменная, Глобальная переменная, Информация о событии).
.png)
Правила именования полей
При создании элементов шаблона действуют следующие ограничения:
- допускаются только латинские буквы (
a–z), цифры (0–9) и символ подчёркивания (_); - максимальная длина имени — 255 символов;
- имена полей не могут повторяться в пределах одного уровня вложенности;
- элементы внутри типа Массив нумеруются автоматически (
0,1,2и т.д.).
Ограничения
При работе с шаблонами учитывайте следующие ограничения:
- один шаблон может содержать не более 100 элементов;
- максимальная глубина вложенности - 4 уровня;
- пустые объекты и массивы автоматически удаляются при сохранении;
- чтобы изменить тип элемента Объект или Массив, необходимо предварительно удалить все вложенные элементы.
Поля типа "Данные подписчика"
При выборе типа Данные подписчика доступны следующие поля.
| Поле | Описание |
|---|---|
| Идентификатор пользователя на платформе | Универсальный ID пользователя |
| Идентификатор пользователя ВКонтакте / Telegram / Макс | ID пользователя на платформе канала |
| Имя | Имя подписчика |
| Фамилия | Фамилия подписчика |
| Дата рождения | Полная дата рождения |
| День рождения | День и месяц рождения (формат дд.мм) |
| Массив с подписками | Список подписок подписчика |
| Массив с метками | UTM-метки подписчика |
| Идентификатор страны | ID страны |
| Страна | Название страны |
| Идентификатор города | ID города |
| Город | Название города |
| Пол | 1 — женский, 2 — мужской |
| Иконка пользователя | Ссылка на аватар |
| Дата первой подписки на сообщения | Дата в читаемом формате |
| Дата первой подписки (unixtime) | Дата в формате Unix timestamp |
| Короткий адрес страницы | Для каналов ВКонтакте |
| Пользователь в Telegram | Username пользователя Telegram |
| Идентификатор сообщества в Senler | Внутренний ID канала в Senler |
| Переменные подписчика | Все пользовательские переменные подписчика |
| Семейное положение | Статус отношений |
| Идентификатор подписчика | Внутренний ID подписчика в Senler |
| Подписан на сообщество | Признак подписки на платформе |
Поля типа "Информация о событии"
При выборе типа Информация о событии доступны следующие поля.
| Поле | Описание |
|---|---|
| Тип события | Подписка, отписка, действие в боте и другие события |
| Идентификатор канала | Тип платформы канала |
| Флаг первой подписки | 1, если пользователь впервые подписался на сообщения |
| Флаг запрета сообщений | Признак отписки от рассылок |
| Идентификатор группы подписчиков | ID группы подписчиков |
| Источник | Источник подписки |
| ID шага | Шаг бота, в котором сработал вебхук |
| ID бота | Бот, в котором сработал вебхук |
| UUID запроса | Уникальный идентификатор запроса |
| Ожидание ответа API | Используется в шагах с ожиданием ответа |
| Идентификатор метки | ID UTM-метки |
| Дата события | Дата и время события |
| Дата события (unixtime) | Дата в формате Unix timestamp |
utm_source | Значение UTM Source |
utm_medium | Значение UTM Medium |
utm_campaign | Значение UTM Campaign |
utm_content | Значение UTM Content |
utm_term | Значение UTM Term |
Типы, не требующие выбора значения
Для некоторых типов значение выбирать не требуется - оно определяется автоматически.
| Тип | Что будет передано в запросе |
|---|---|
| Константа | Текст, введённый в поле Значение |
| Идентификатор сообщества ВКонтакте / Telegram | ID сообщества на платформе |
| Внешний идентификатор платформы | Внешний ID канала |
| Секретный ключ | Секретный ключ WebHook API канала |
| Массив глобальных переменных | Объект, содержащий все глобальные переменные канала |