Skip to main content
POST
Record a storefront product event

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_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) or tybrite_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

application/json
event_type
enum<string>
required
Available options:
view,
add_to_cart,
add_to_wishlist
variant_id
string<uuid>

The product variant the shopper interacted with. Either variant_id or product_id is required.

product_id
string<uuid>

The product the shopper interacted with. Either variant_id or product_id is required.

session_id
string

The shopper's browsing-session identifier (same concept as the anonymous cart session). May also be sent as the x-session-id header.

customer_id
string<uuid>

The signed-in shopper, when known.

Response

The event was accepted.

recorded
boolean