Achievements
Streaks
Points
Streak started
Triggered when a user starts a streak.
Body
The webhook event.
The webhook event type.
streak.started The user who started the streak.
Show child attributes
Show child attributes
The ID of the user in your database. Must be a string.
"user-id"
The user's email address.
The name of the user.
"John Doe"
The user's timezone.
"Europe/London"
The user's device tokens.
The device token.
["token1", "token2"]Whether the user is opted into receiving Trophy-powered emails.
true
Whether the user is in the control group, meaning they do not receive emails or other communications from Trophy.
false
The date and time the user was created, in ISO 8601 format.
"2021-01-01T00:00:00Z"
The date and time the user was last updated, in ISO 8601 format.
"2021-01-01T00:00:00Z"
The streak that was started.
Show child attributes
Show child attributes
The length of the user's current streak.
The frequency of the streak.
daily, weekly, monthly The date the streak started.
The start date of the current streak period.
The end date of the current streak period.
The date the streak will expire if the user does not increment a metric.
The number of available streak freezes. Only present if the organization has enabled streak freezes.
The maximum number of streak freezes a user can have. Only present if the organization has enabled streak freezes.
The interval at which the user will earn streak freezes, in days. Only present if the organization has enabled streak freeze auto-earn.
The amount of streak freezes the user will earn per interval. Only present if the organization has enabled streak freeze auto-earn.
Response
Return a 200 status to indicate the webhook was received and processed.
Was this page helpful?