Skip to main content
WEBHOOK
streak.extended
{
  "type": "streak.extended",
  "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": 2,
    "frequency": "daily",
    "periodStart": "2025-04-03",
    "periodEnd": "2025-04-03",
    "started": "2025-04-02",
    "expires": "2025-04-05",
    "freezes": 0,
    "maxFreezes": 3,
    "freezeAutoEarnInterval": 7,
    "freezeAutoEarnAmount": 1
  }
}
Does not apply to streak freeze consumption.

Body

application/json

The webhook event.

​
type
enum<string>
required

The webhook event type.

Available options:
streak.extended
​
user
object
required

The user who extended the streak. An object with editable user fields.

​
streak
object
required

The streak that was extended.

Response

200

Return a 200 status to indicate the webhook was received and processed.

⌘I