Record a storefront product event
Records a shopper interaction with a product — a product view, an add-to-cart, or an
add-to-wishlist. These events power the “next-likely-item” recommendation (the next
recommendation type): the products a shopper is most likely to view or add next, given
what they have done in the current session.
Send the event as the shopper interacts with the storefront. Provide a stable session_id
per browsing session (the same identifier you use for an anonymous cart) so events can be
grouped into a session path; include customer_id when the shopper is signed in.
The event references a product by variant_id (resolved to its product automatically) or
directly by product_id. Publishable keys are accepted, so the call can be made from the
browser. The request is processed best-effort and returns immediately; it never blocks
the page.
Authorizations
API Key Authentication
Use your API key in the Authorization header:
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: write operations, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Read-only access (GET requests only, plus POST semantic search)
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): Secret key required - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - All write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Body
view, add_to_cart, add_to_wishlist The product variant the shopper interacted with. Either variant_id or product_id is required.
The product the shopper interacted with. Either variant_id or product_id is required.
The shopper's browsing-session identifier (same concept as the anonymous cart session). May also be sent as the x-session-id header.
The signed-in shopper, when known.
Response
The event was accepted.

