Skip to main content

Endpoint

Send a batch of behavioral events (page views, clicks, form submissions, etc.) for tracking and analysis. Events are used by the AI’s awareness system to understand user behavior patterns.

Authentication

Requires your publishable widget key in the Authorization header:

Request Body

array
required
Array of event objects (max 100 per batch).
string
The user’s external ID. If provided, events are linked to the user record. The user is automatically upserted (created if new, updated with a fresh last_seen timestamp if existing).
string
Session identifier to group events.

Event Object

Each event in the array should have:
string
required
The type of event (e.g., "click", "page_view", "form_submit", "error").
string
CSS selector of the element involved (for click events, etc.).
string
The URL where the event occurred.
object
Additional data about the event. Max 10,000 bytes per event.

Example

Response:

Notes

  • Events are collected automatically by the built-in tracker. You typically don’t need to call this endpoint directly unless building a custom integration.
  • The user record is created or updated (last seen timestamp) when user_id is provided.
  • Field lengths are sanitized: event_type is capped at 100 chars, element_selector at 500 chars, page_url at 2,000 chars, and session_id at 200 chars.