Skip to main content
WEBHOOK
streak.lost
{
  "type": "streak.lost",
  "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"
    }
  },
  "length": 7
}

Body

application/json

The webhook event.

type
enum<string>
required

The webhook event type.

Available options:
streak.lost
user
object
required

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

length
integer
required

The length of the streak that was lost.

Response

200

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

I