EventsTrack event

Track event

Record a user event.

curl -X POST "https://api.flameup.ai/api/v1/track" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "external_id": "example_string",
  "userId": "example_string",
  "event": "example_string",
  "parameters": {},
  "properties": {},
  "timestamp": "2024-12-25T10:00:00Z"
}'
{
  "success": true,
  "event_id": "example_string"
}
POST
/track
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Your Flameup API key (passed as Bearer token)

Your Flameup API key (passed as Bearer token)
Content-Typestring
Required

The media type of the request body

Options: application/json
external_idstring
Required

User identifier (external_id or email)

userIdstring

Deprecated alias for external_id

parametersobject

Event parameters

propertiesobject

Alias for parameters

timestampstring

When the event occurred (defaults to now)

Format: date-time
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Your Flameup API key (passed as Bearer token)

Body

application/json
external_idstring
Required

User identifier (external_id or email)

userIdstring

Deprecated alias for external_id

parametersobject

Event parameters

propertiesobject

Alias for parameters

timestampstring

When the event occurred (defaults to now)

Responses

successboolean
event_idstring