Create Event

POST {{baseUrl}}/api/events/

Create an event. Events are created asynchronously. Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.

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

Scopes: Events Write

Request Body

{"data"=>{"type"=>"event", "attributes"=>{"profile"=>{"$email"=>"matt.kemp@klaviyo-demo.com"}, "metric"=>{"name"=>"Viewed Product", "service"=>"Duis dolore eiusmod Ut non"}, "properties"=>{"Brand"=>"Kids Book", "Categories"=>["Fiction", "Children"], "ProductID"=>1111, "ProductName"=>"Winnie the Pooh", "$extra"=>{"URL"=>"http://www.example.com/path/to/product", "ImageURL"=>"http://www.example.com/path/to/product/image.png"}}, "time"=>"2022-11-08T00:00:00", "value"=>9.99, "unique_id"=>"ea in deserunt"}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring
Acceptstring