Streak extended

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

User · object

required

The user who extended the streak.

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"

streak

Streak Response · object

required

The streak that was extended.

Show child attributes

streak.length

integer

required

The length of the user's current streak.

streak.frequency

enum<string>

required

The frequency of the streak.

Available options:

daily,

weekly,

monthly

streak.started

string<date> | null

required

The date the streak started.

streak.periodStart

string<date> | null

required

The start date of the current streak period.

streak.periodEnd

string<date> | null

required

The end date of the current streak period.

streak.expires

string<date> | null

required

The date the streak will expire if the user does not increment a metric.

streak.freezes

integer

The number of available streak freezes. Only present if the organization has enabled streak freezes.

streak.maxFreezes

integer

The maximum number of streak freezes a user can have. Only present if the organization has enabled streak freezes.

streak.freezeAutoEarnInterval

integer

The interval at which the user will earn streak freezes, in days. Only present if the organization has enabled streak freeze auto-earn.

streak.freezeAutoEarnAmount

integer

The amount of streak freezes the user will earn per interval. Only present if the organization has enabled streak freeze auto-earn.

Response

200

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

Overview

Achievements

Streaks

Points

Leaderboards

Body

Response