Skip to main content
POST
/
track
Track a single event
curl --request POST \
  --url https://{host}/v1/track \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "messageId": "8b0f62f9-1e8e-4f15-8c2a-9d23c9c6c0e2",
  "event": "signup",
  "timestamp": "2025-10-29T22:00:00.778Z",
  "properties": {
    "plan": "basic",
    "accountType": "email",
    "freeTrial": true
  }
}'
{
  "status": "ok",
  "messageId": "8b0f62f9-1e8e-4f15-8c2a-9d23c9c6c0e2"
}

Authorizations

Authorization
string
header
required

Include your API key as:

Authorization: Bearer YOUR_API_KEY

Body

application/json
event
string
required

The name/type of the event.

Example:

"signup"

timestamp
string<date-time>
required

When the event occurred.

Example:

"2025-10-29T22:00:00.778Z"

properties
object
required

Event-specific key/value pairs.

Example:
{
"plan": "basic",
"accountType": "email",
"freeTrial": true
}
messageId
string

Unique identifier for this event. If not provided by the client, the server will generate one automatically. Used for deduplication and traceability through downstream systems.

Example:

"8b0f62f9-1e8e-4f15-8c2a-9d23c9c6c0e2"

Response

Request accepted and processed successfully.

  • Option 1
  • Option 2

Response for a single event.

status
string
Example:

"ok"

messageId
string

Unique ID assigned to the processed event.

Example:

"8b0f62f9-1e8e-4f15-8c2a-9d23c9c6c0e2"