Sign in
analytics

Record an explicit app foreground event

post/api/analytics/app-lifecycle

Request body

event_idstring uuid required

Client-generated idempotency UUID

open_type'cold_start' | 'resume' required

How the native app entered the foreground.

occurred_atstring date-time required

Timezone-aware client timestamp

channel'native_app' | 'web' required

Delivery channel used for an app-open event.

platform'ios' | 'android' | 'web' required

Runtime platform used for an app-open event.

form_factor'mobile' | 'tablet' | 'desktop' required

Physical device class used for an app-open event.

app_versionstring nullable
device_idstring uuid required

Stable client UUID; reuse the chat device UUID in the native app

Example request

{
  "app_version": "2.5.0",
  "channel": "native_app",
  "device_id": "8ec8e128-c659-4f91-b230-d19b57c8392d",
  "event_id": "2a70ce0d-b421-45a1-a9b0-a9875cc766d6",
  "form_factor": "mobile",
  "occurred_at": "2026-08-27T10:15:00Z",
  "open_type": "cold_start",
  "platform": "ios"
}

Response

Successful Response

access_idstring uuid required
event_idstring uuid required
recorded_atstring date-time required
createdboolean required

False when this event_id was already recorded

Changes