Automations And Webhooks
Send Streakfox events from Zapier, Pipedream, n8n, Make, or your own backend.
This guide covers inbound events from automation tools into Streakfox. Use the program webhook endpoint when Zapier, Pipedream, n8n, Make, or another system needs to count an action toward a program:
POST /v1/webhook/YOUR_SITE_KEY/e HTTP/1.1
Host: api.streakfox.com
Content-Type: application/json
X-Streak-Webhook-Secret: whsec_...
{
"siteKey": "YOUR_SITE_KEY",
"userHash": "user_abc123",
"event": "lesson_complete",
"eventType": "streak_interaction",
"externalService": "zapier",
"integrationId": "course-complete-zap",
"meta": {
"courseId": "course_123"
}
}Required Fields
| Field | Description |
|---|---|
siteKey | Project site key from the dashboard. |
userHash | Stable user identifier. Hash emails or internal IDs before sending. |
event | Program event key to count. |
X-Streak-Webhook-Secret | Program webhook secret from the dashboard. |
Source Labels
Set externalService and integrationId so analytics can show where events came from.
Common values:
zapierpipedreamn8nmakeshopifygithub-actionsinternal-cron
When To Use Server Events Instead
Use POST /v1/server/e when the event comes directly from your own backend. Use the webhook endpoint when the event is triggered by a third-party automation or integration tool.
Outbound Action Webhooks
The dashboard Programs page also has an Action webhook section for Streakfox outputs. When an action webhook is enabled for a program, Streakfox queues signed deliveries for the selected event types:
| Event | When it is queued |
|---|---|
milestone.achieved | A visitor reaches a milestone target. |
reward.unlocked | A visitor unlocks a milestone with a configured reward. |
streak.at_risk | A daily continuous streak passes the configured at-risk threshold. |
streak.broken | A daily continuous streak passes the configured broken threshold. |
Retention delivery currently supports daily continuous streaks. Non-daily retention cadence delivery remains a follow-up.