API
API Overview
Core concepts for calling the Streakfox HTTP and webhook APIs.
Every public HTTP request lives under https://api.streakfox.com. Most endpoints identify the project by your project key, sent as siteKey or in the URL.
Authentication
- Counting actions: Post from your server or automation to
/v1/webhook/:siteKey/ewith the program'sX-Streak-Webhook-Secret. Server-to-server ingest always uses this endpoint. - Showing progress: The widget script reads state from the browser. Requests are checked against your website address saved in Streakfox.
Rate limits
Each project is limited to 50 requests per second by default. Contact support for higher throughput.
Resources
| Resource | Description |
|---|---|
/v1/webhook/:siteKey/e | Count an action from your server or automation |
/v1/state | Read a member's streak for display |
/v1/alias | Link an anonymous visitor to a member with a signed token |
Jump into the dedicated pages for request/response references and sample code.