Добавить событие для клиента

POST {{baseUrl}}/customers/{id}/events

Добавляет пользовательское событие (например, отправку формы, телефонный звонок, веб-перехватчик или действие интеграции) к существующей записи клиента.

Заголовки:

X-Api-Key: your_secret_api_key  
Content-Type: application/json

Path parameters:

id (GUID): The unique identifier of the customer to whom the event should be attached.

Тело запроса:

{
  "event": "some_event", // Уникальный идентификатор события. Используйте форматирование lowercase_snake_case.
  "data": "any data you want", // Строка, содержащая любые соответствующие данные о событии. Вы можете использовать строку в кодировке JSON для хранения структурированных данных (объектов, массивов и т. д.).
  "utmData": { // (Необязательно)
    "source": null,    // Соответствует параметру utm_source (например, "google", "facebook").
    "medium": null,    // Соответствует параметру utm_medium (например, "cpc", "email").
    "campaign": null,  // Соответствует параметру utm_campaign (например, "spring_sale").
    "term": null,      // Соответствует параметру utm_term (используется для отслеживания платных ключевых слов).
    "content": null    // Соответствует параметру utm_content (используется для различения рекламы или ссылок).
  },
  "eventDateTime": "2025-06-15T21:28:22.734Z" // (Необязательно) Временная метка события в формате UTC (ISO 8601). Если не указано, сервер будет использовать текущее время.
}

Полные модели запросов и ответов см. в разделе «Reference».

Best PracticesCopied!

Всегда используйте UTC для значений eventDateTime, чтобы поддерживать согласованность в распределенных системах и надлежащую функциональность отчетов.
Если вы хотите отправить событие для клиента, который еще не создан, сохраните все события, которые должны быть отправлены с датой и временем, в локальном хранилище или переменной в памяти. Отправляйте их сразу после получения идентификатора клиента из запроса Create a Customer.
Используйте lowercase_snake_case для названий событий. Не используйте camelCase или любые другие вариации.