Skip to main content
WEBHOOK
streak.freeze_consumed
{
  "type": "streak.freeze_consumed",
  "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"
    }
  },
  "consumed": 1,
  "freezes": 2
}

Body

application/json

The webhook event.

​
type
enum<string>
required

The webhook event type.

Available options:
streak.freeze_consumed
​
user
object
required

The user whose streak freeze was consumed. An object with editable user fields.

​
consumed
integer
required

The number of freezes consumed.

​
freezes
integer
required

The total number of freezes the user has left after the consumption.

Response

200

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

⌘I