POST
/
v1
/
track
Track Events
curl --request POST \
  --url https://{environment}.userpilot.io/v1/track \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "user_789456",
  "event_name": "schedule_appointment",
  "metadata": {
    "appointment_date": "2024-02-01T10:00:00Z",
    "appointment_type": "Initial Consultation",
    "scheduled_by": "Sarah Johnson",
    "specialty": "Cardiology",
    "provider_id": "dr_smith_123",
    "appointment_status": "confirmed"
  }
}'
This response does not have an example.

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