Валідація параметрів подій | 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 символів.

Залишилися питання?
Спеціалісти обов'язково нададуть відповідь та допоможуть вирішити вашу проблему!
Зворотний дзвінок
Залишіть заявку – і наш спеціаліст зв'яжеться з вами в робочий час.
Відправити заявку
Консультація в чаті
Готові до ваших запитань!
Написати в чат
Електронна пошта
Напишіть в службу підтримки eSputnik.
Надіслати email