Create Client Event

POST {{baseUrl}}/client/events/?company_id={{companyId}}

Create a new event to track a profile's activity.

This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a public API key (site ID). Never use a private API key with our client-side endpoints.

To create events from server-side applications, please use POST /api/events.

Note that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.

Rate limits:
Burst: 350/s
Steady: 3500/m

Scopes: events:write

Request Params

Request Body

{"data"=>{"type"=>"event", "attributes"=>{"metric"=>{"data"=>{"type"=>"metric", "attributes"=>{"name"=>"<string>", "service"=>"<string>"}}}, "profile"=>{"data"=>{"type"=>"profile", "attributes"=>{"email"=>"<string>", "phone_number"=>"<string>", "external_id"=>"<string>", "anonymous_id"=>"<string>", "_kx"=>"<string>", "first_name"=>"<string>", "last_name"=>"<string>", "organization"=>"<string>", "title"=>"<string>", "image"=>"<string>", "location"=>{"address1"=>"<string>", "address2"=>"<string>", "city"=>"<string>", "country"=>"<string>", "latitude"=>"<string>", "longitude"=>"<string>", "region"=>"<string>", "zip"=>"<string>", "timezone"=>"<string>", "ip"=>"<string>"}, "meta"=>{"patch_properties"=>{"unset"=>"<string>"}}}, "id"=>"<string>"}}, "time"=>"<dateTime>", "value"=>"<number>", "value_currency"=>"<string>", "unique_id"=>"<string>"}}}

HEADERS