API Documentation

Reference docs for events ingestion, identity, and integration patterns.

API changelog

2026-03

Added

  • action field on v2 event ingestion requests (entity noun + verb split)
  • action and canonical_name fields in all event responses (v1 and v2)
  • Deprecation headers (Deprecation: true, Sunset: 2026-09-01) on v2 requests using legacy flat event_type format

Updated

  • v2 event naming: prefer event_type (noun) + action (verb) over flat event_type
  • v1 response now returns split event_type, action, and canonical_name

2026-02

Added

  • POST /api/v2/events for custom event ingestion
  • POST /api/v2/events/batch for batch ingestion
  • POST /api/v2/identify for user identity upsert
  • POST /api/v2/alias for identity merge
  • session_start and session_end in canonical v1 events

Updated

  • Event catalog and inferred property schema support
  • User journey views linked to identified users

Compatibility notes

  • v1 remains supported and strict (canonical events only)
  • v2 is recommended for new integrations