Streak freeze earned

Body

application/json

The webhook event.

type

enum<string>

required

The webhook event type.

Available options:

streak.freeze_earned

user

User · object

required

The user who earned streak freezes.

Show child attributes

user.id

string

required

The ID of the user in your database. Must be a string.

Example:

"user-id"

user.email

string | null

required

The user's email address.

Example:

"[email protected]"

user.name

string | null

required

The name of the user.

Example:

"John Doe"

user.tz

string | null

required

The user's timezone.

Example:

"Europe/London"

user.deviceTokens

string[]

required

The user's device tokens.

The device token.

Example:

["token1", "token2"]

Whether the user is opted into receiving Trophy-powered emails.

Example:

true

user.attributes

object

required

User attributes as key-value pairs. Keys must match existing user attributes set up in the Trophy dashboard.

Show child attributes

user.attributes.{key}

string

Example:

{
  "department": "engineering",
  "role": "developer"
}

user.control

boolean

required

Whether the user is in the control group, meaning they do not receive emails or other communications from Trophy.

Example:

false

user.created

string<date-time>

required

The date and time the user was created, in ISO 8601 format.

Example:

"2021-01-01T00:00:00Z"

user.updated

string<date-time>

required

The date and time the user was last updated, in ISO 8601 format.

Example:

"2021-01-01T00:00:00Z"

earned

integer

required

The number of freezes earned.

freezes

integer

required

The total number of freezes the user has after the event.

Response

200

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

Overview

Achievements

Streaks

Points

Leaderboards

Body

Response