Getting started with Streakfox

You'll have a live streak in four steps. Connect the action you want members to repeat, send one test, go live, then show members their progress.

Two names you'll see everywhere:

• Project key identifies your project. It's public and safe to put in a web page.
• Action is the thing you count, such as lesson_complete or order_placed.

1) Pick how actions reach Streakfox

Actions are counted from your server or an automation, never from the browser. That keeps progress honest. Pick one:

• Course platform, Zapier or Make. Teachable, Thinkific, Circle, LearnWorlds or Shopify Flow, with no code. Copy one URL into a Zapier or Make step and map the member's email. Follow the no-code guide instead of this page.
• WordPress. Install the plugin and it sends LearnDash lessons or approved comments for you. Follow the WordPress guide, then skip to step 3.
• Webhook. Anything that can send an HTTP POST works: your own backend, Zapier, Make, n8n or Pipedream.

You'll find your webhook URL and secret in the dashboard during onboarding, on the Connect the action step. It shows a ready-to-copy curl command. You can also find them later under Programs → Connections.

2) Send a test action

Send one action for a member. Run this from a terminal or your server:

curl -X POST https://api.streakfox.com/v1/webhook/YOUR_PROJECT_KEY/e \
  -H "Content-Type: application/json" \
  -H "X-Streak-Webhook-Secret: YOUR_WEBHOOK_SECRET" \
  -d '{
    "event": "lesson_complete",
    "userHash": "member_123",
    "idempotencyKey": "lesson_42:member_123"
  }'

• event is your action.
• userHash is your member ID. Use the same stable ID for a member every time. Hash emails or internal IDs before you send them.
• idempotencyKey is a unique ID for this one completion. Send the same key on a retry and it only counts once.

A 202 response with {"ok": true} means Streakfox has the action. If you get an error, the Events API lists each code with its fix.

3) Watch the test count

Back in onboarding, the test run screen confirms when the member's progress moves.

Until your program is live, every action it receives counts as a test. You don't need to flag anything. Test progress never sends real member follow-ups, so test as much as you like.

4) Go live

Going live needs one real action from your site or sender, not the dashboard, that moved a member's progress. Complete the action for real (finish a lesson, place an order), then choose Go live.

From then on every action counts for real.

5) Show members their progress

Add the widget to pages where members are signed in. It shows their streak. It doesn't count anything.

<script
  src="https://cdn.streakfox.com/widget.js"
  data-project="YOUR_PROJECT_KEY"
  data-event="lesson_complete"
  data-user-hash="MEMBER_ID"
  defer
></script>

• data-project is your project key.
• data-event is the action this widget shows.
• data-user-hash is the same member ID you send in step 2. If it doesn't match, the widget shows a fresh streak.

Add your website address in Streakfox so the widget can load on your site. Onboarding asks for it on the widget step.

Next steps

• Every field and error: Events API
• Connect Zapier, Make, n8n or Pipedream: Automations and webhooks
• Keep one member's streak together across devices: Connecting users
• Cadence, targets and milestones: Programs