API
API Overview
Core concepts for calling the Streakfox HTTP, server event, and webhook APIs.
Every public HTTP request lives under https://api.streakfox.com. Most endpoints identify the project via siteKey (project ID).
Authentication
- Browser: Use the Web SDK or widget script. Requests are gated by
Originand your project's allowed domains. - Server events: Use
X-Streak-Server-Tokenwith/v1/server/e. - Inbound webhooks: Use the per-program
X-Streak-Webhook-Secretwith/v1/webhook/:siteKey/e. - Admin routes: Use admin tokens only for privileged routes like
/admin/alias.
Rate limits
Each project is limited to 50 requests per second by default. Contact support for higher throughput.
Resources
| Resource | Description |
|---|---|
/v1/e | Record browser/widget streak events |
/v1/server/e | Record trusted server-side streak events |
/v1/webhook/:siteKey/e | Record third-party automation or webhook events |
/v1/state | Fetch widget state for a user |
/v1/alias | Alias anonymous users via a signed token |
/admin/alias | Alias users with an admin token (server-only) |
Jump into the dedicated pages for request/response references and sample code.