latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-18269154992.5 KB

8fbabe82a04d

Web Tracking Keys

Create a web tracking key

Creates a publishable key for the browser tracking SDK and returns the script tag to install. The key ships in page source by design and authorizes storefront events only, never the rest of the API. Events start flowing once the snippet is deployed and nothing is backfilled for the period before that. Always pass allowedOrigins - an empty allowlist accepts events from any site. Requires the integrations:manage scope.

post/web-tracking-keys

Request body

namestring required

Human-readable label, e.g. Storefront.

allowedOriginsstring[]

Origins allowed to use this key. A bare domain is read as https. A leading *. matches subdomains at any depth but not the apex. Omitting this leaves the key unrestricted.

Response

Key created

successboolean
messagestring