Валидация параметров события | Support eSputnik

Пользовательские данные

Email

Омниканальность

Автоматизация

Валидация параметров события

События, которые отправляются в eSputnik, должны соответствовать определенным требованиям. В противном случае сценарии могут не срабатывать, важные данные — теряться, и т. д.

eSputnik позволяет устанавливать необходимые параметры события, предупреждает об ошибках и показывает, что именно и как нужно исправить.

Установка необходимых параметров события

Задайте необходимые параметры, без которых система не будет принимать события.

Шаги по настройке валидации структуры события:

  1. Создайте новое событие или зайдите в настройки уже созданного (инструкция по созданию событий).
  2. Активируйте свитчер “Валидировать параметры”.
  3. Кликните “+ Добавить параметр”.
  4. Введите название параметра в соответствующее поле и при необходимости установите флажок “Обязательный параметр”.
  5. При необходимости добавьте другие параметры, затем нажмите “Редактировать“.

Валидация параметров

Валидация параметров событий

Валидируйте параметры и структуру события с помощью API-метода Generate event. Укажите параметры в массиве params.

Generate event

В ответ на невалидное событие отправляется сообщение об ошибке 400 bad request и требования к событию.

Пример ответа:

The event should have the following params: [
    {
        "name": "EmailAddress",
        "required": true
    },
    {
        "name": "Phone Number",
        "required": false
    },
    {
        "name": "Name",
        "required": false
    }
]

Типы событий с включенной валидацией параметров обозначаются иконкой проверки.

Типы событий с включенной валидацией параметров

Требования к событиям

Параметры запроса Тип Обязательный/Опциональный

Описание

Требования
eventTypeKey String

Required

Идентификатор типа события. Если типа события с таким ключом не существует, создается новое.

1. Можно использовать любые символы, кроме < ; ’ \ / | " ` ' ^ ? ! , >

 

2. Макс. длина: 100 символов.

keyValue

String

Optional

Ключ события, определяющий его уникальность. Если вы не передаете значение  keyValue в событии, оно автоматически подставляется из объекта запроса Params с таким приоритетом:
  • contactId;
  • externalCustomerId;
  • email;
  • phone;
  • pushToken (web или mobile).

 

Событие без одного из этих параметров или переданного значения keyValue не принимается.

1. Ключ должен содержать уникальное значение для каждого контакта (например, email, номер телефона, внешний ID и т. д.).

 

2. Можно использовать любые символы, кроме < ; ’ \ / | " ` ' ^ ? ! , >

 

3. Макс. длина: 300 символов

params Array of objects

Optional

Список параметров события, представленный в виде массива пар "ключ" —"значение". Ключи параметров произвольны.

Параметры используются в кампаниях и для создания.

1. Массив параметров может быть пустым: []
Но если массив не пуст, поля name и value должны передаваться в объекте массива.

 

2. Значение параметра name должно быть уникальным.

 

3. Макс. длина значения параметра name: 100 символов.

Дополнительную информацию см. в API-документации.

Остались вопросы?
Специалисты обязательно ответят и помогут решить вашу проблему!
Обратный звонок
Оставьте заявку – и наш специалист свяжется с вами в рабочее время.
Отправить заявку
Консультация в чате
Готовы к вашим вопросам!
Написать в чат
Электронная почта
Напишите в службу поддержки eSputnik.
Отправить email