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

Параметр Тип

Обов'язковий/Опціональний

Опис Вимоги
eventTypeKey

String

Обов'язковий Унікальний ідентифікатор типу події, наприклад, PageViewed. Після першого запиту він з'явиться у вашому обліковому записі, і ви зможете побачити його у розділі “Тригери” → “Типи подій”.

1. Можна використовувати будь-які символи, крім < ; ’ \ / | " ` ' ^ ? ! , >

 

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

eventParams

eventParams містять два типи інформації:

  • Ідентифікатори контактів (обов'язково). Приклад:
{
   "name": "externalCustomerId",
   "value": "a7c9f9b8-d3a2-401c-8b93-7f3d4f91bfa2"
}
  • Додаткові параметри події (опційно). Приклад:
{  
  "name": "cartId",  
  "value": "CART12345"  
}
Параметр Тип

Обов'язковий/Опціональний

Опис Вимоги
Ідентифікатори контактів

String

Обов'язковий

eventParams повинні містити ідентифікатор контакту для визначення унікальності події. Пріоритет параметрів наступний:
- contactId (внутрішній ідентифікатор контакту в нашій системі);
- externalCustomerId (внутрішній ідентифікатор контакту у вашій системі);
- email;
- phone;
- pushToken (веб або мобільний). 

Подія повинна містити хоча б один із цих параметрів.

Рекомендований параметр: externalCustomerId.

1. Можна використовувати будь-які символи, крім < ; ’ \ / | " ` ' ^ ? ! , >
 
2. Макс. довжина: 300 символів.


Додаткові параметри події

Масив об'єктів Опціональний Масив об'єктів — списки з парами “ключ-значення”, що містять параметри події.

1. Масив параметрів може бути пустим: []
Але якщо масив не порожній, поля name і value повинні передаватися в об'єкті масиву.

2. Значення параметра name має бути унікальним.

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

Приклад події AbandonedCart >

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