Events
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.
POST
/
v1
/
events
Record a storefront product event
curl --request POST \
--url https://api.tybritelabs.com/v1/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event_type": "view",
"variant_id": "9a47e047-b1b6-4c35-9617-820629e22e04",
"session_id": "7c1f0e8a-2b3c-4d5e-9f01-23456789abcd"
}
'import requests
url = "https://api.tybritelabs.com/v1/events"
payload = {
"event_type": "view",
"variant_id": "9a47e047-b1b6-4c35-9617-820629e22e04",
"session_id": "7c1f0e8a-2b3c-4d5e-9f01-23456789abcd"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event_type: 'view',
variant_id: '9a47e047-b1b6-4c35-9617-820629e22e04',
session_id: '7c1f0e8a-2b3c-4d5e-9f01-23456789abcd'
})
};
fetch('https://api.tybritelabs.com/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tybritelabs.com/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_type' => 'view',
'variant_id' => '9a47e047-b1b6-4c35-9617-820629e22e04',
'session_id' => '7c1f0e8a-2b3c-4d5e-9f01-23456789abcd'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/events"
payload := strings.NewReader("{\n \"event_type\": \"view\",\n \"variant_id\": \"9a47e047-b1b6-4c35-9617-820629e22e04\",\n \"session_id\": \"7c1f0e8a-2b3c-4d5e-9f01-23456789abcd\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tybritelabs.com/v1/events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event_type\": \"view\",\n \"variant_id\": \"9a47e047-b1b6-4c35-9617-820629e22e04\",\n \"session_id\": \"7c1f0e8a-2b3c-4d5e-9f01-23456789abcd\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_type\": \"view\",\n \"variant_id\": \"9a47e047-b1b6-4c35-9617-820629e22e04\",\n \"session_id\": \"7c1f0e8a-2b3c-4d5e-9f01-23456789abcd\"\n}"
response = http.request(request)
puts response.read_body{
"recorded": true
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests for this API key. Please slow down and try again shortly.",
"remaining": 0,
"reset": 1706198400
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}Authorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
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: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
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) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Headers
Where the shopper was, when it is easier to set a header than to add a body field — marketplace from a marketplace storefront, storefront (or omitted) for a seller's own site. Equivalent to the channel body field; the body wins if both are sent. The marketplace itself is resolved server-side from the store, so this says which channel and cannot name one.
Available options:
storefront, marketplace Body
application/json
Available options:
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.
Where the shopper was when this happened. Send marketplace from a marketplace storefront so the event is attributed to that marketplace rather than to the seller's own shop; omit it, or send storefront, for a seller's own site. The marketplace itself is resolved server-side from the store, so this only says which channel — it cannot name one. May also be sent as the x-tybrite-channel header.
Available options:
storefront, marketplace Response
The event was accepted.
⌘I
Record a storefront product event
curl --request POST \
--url https://api.tybritelabs.com/v1/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event_type": "view",
"variant_id": "9a47e047-b1b6-4c35-9617-820629e22e04",
"session_id": "7c1f0e8a-2b3c-4d5e-9f01-23456789abcd"
}
'import requests
url = "https://api.tybritelabs.com/v1/events"
payload = {
"event_type": "view",
"variant_id": "9a47e047-b1b6-4c35-9617-820629e22e04",
"session_id": "7c1f0e8a-2b3c-4d5e-9f01-23456789abcd"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event_type: 'view',
variant_id: '9a47e047-b1b6-4c35-9617-820629e22e04',
session_id: '7c1f0e8a-2b3c-4d5e-9f01-23456789abcd'
})
};
fetch('https://api.tybritelabs.com/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tybritelabs.com/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_type' => 'view',
'variant_id' => '9a47e047-b1b6-4c35-9617-820629e22e04',
'session_id' => '7c1f0e8a-2b3c-4d5e-9f01-23456789abcd'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/events"
payload := strings.NewReader("{\n \"event_type\": \"view\",\n \"variant_id\": \"9a47e047-b1b6-4c35-9617-820629e22e04\",\n \"session_id\": \"7c1f0e8a-2b3c-4d5e-9f01-23456789abcd\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tybritelabs.com/v1/events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event_type\": \"view\",\n \"variant_id\": \"9a47e047-b1b6-4c35-9617-820629e22e04\",\n \"session_id\": \"7c1f0e8a-2b3c-4d5e-9f01-23456789abcd\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_type\": \"view\",\n \"variant_id\": \"9a47e047-b1b6-4c35-9617-820629e22e04\",\n \"session_id\": \"7c1f0e8a-2b3c-4d5e-9f01-23456789abcd\"\n}"
response = http.request(request)
puts response.read_body{
"recorded": true
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests for this API key. Please slow down and try again shortly.",
"remaining": 0,
"reset": 1706198400
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}