{ "type": "streak.started", "user": { "id": "user-id", "email": "user@example.com", "tz": "Europe/London", "subscribedToEmails": true, "created": "2021-01-01T00:00:00Z", "updated": "2021-01-01T00:00:00Z", "attributes": { "department": "engineering", "role": "developer" } }, "streak": { "length": 1, "frequency": "daily", "periodStart": "2025-04-02", "periodEnd": "2025-04-02", "started": "2025-04-02", "expires": "2025-04-03", "freezes": 0, "maxFreezes": 3, "freezeAutoEarnInterval": 7, "freezeAutoEarnAmount": 1 } }
The webhook event.
The webhook event type.
streak.started
The user who started the streak. An object with editable user fields.
Show child attributes
The streak that was started.
Return a 200 status to indicate the webhook was received and processed.
Was this page helpful?