Skip to main content
POST
Send event

Authorizations

Authorization
string
header
required

Your partner API key: kp_live_… in production, kp_test_… on the sandbox retailer.

Headers

Kleep-Retailer
string<uuid>
required

The retailer's Kleep public_id. Every call is scoped to one retailer.

Body

application/json
type
enum<string>
required
Available options:
recommendation_shown,
added_to_cart,
order_placed
recommendation_id
string
required
variant_id
string

added_to_cart and order_placed: the variant bought.

order_id
string

order_placed: the retailer's order ID.

conversation_id
string
occurred_at
string<date-time>

Defaults to the time Kleep receives the event.

Response

Accepted.