Skip to main content
POST
Track Events

Headers

Content-Type
string
Accept
string
Authorization
string
default:Token ABC_1234_EFGH_5678
required

API authentication token in the format: Token {{API_KEY}} Obtain your API key from the Userpilot Environment Settings.

Body

application/json
user_id
string
required

The unique identifier for the user. This is the ID that Userpilot uses to identify the user.

Example:

"user_789456"

event_name
string
required

Name of the event being tracked. Use descriptive names like 'schedule_appointment', 'purchase_completed', etc.

Example:

"schedule_appointment"

metadata
object

Optional event metadata. You can add, remove, or modify any properties as needed for your use case.

Response

Accepted - Event tracking successful