API Documentation

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

Quickstart

This quickstart sends a first event and links a user profile.

1) Create an Events API key

From your product area, create an API key and copy the token.

2) Send your first event

bash
curl -X POST "/api/v2/events" \
  -H "Authorization: Bearer YOUR_EVENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "user",
    "action": "signed_up",
    "subject_type": "user",
    "subject_id": "user_123",
    "occurred_at": "2026-02-10T12:00:00Z",
    "external_id": "my-app:user_signed_up:user_123:1739188800",
    "properties": {
      "plan": "starter",
      "source": "landing_page"
    }
  }'

3) Identify that user

bash
curl -X POST "/api/v2/identify" \
  -H "Authorization: Bearer YOUR_EVENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "user_123",
    "identifiers": {
      "email": "[email protected]",
      "stripe_customer_id": "cus_123"
    },
    "traits": {
      "name": "Jane Founder",
      "plan": "starter"
    }
  }'

4) Check product area

After ingestion:

  • Event appears in Activity and Event Catalog
  • User appears in Users with a journey timeline