Achievements
Streaks
Points
Points changed
Triggered when a user is awarded or loses points.
Body
The webhook event.
The webhook event type.
points.changed The user whose points increased or decreased.
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 user's points after the event.
Show child attributes
Show child attributes
The ID of the points system
The key of the points system
The name of the points system
The description of the points system
The URL of the badge image for the points system
The maximum number of points a user can be awarded in this points system
The user's total points
Array of trigger awards that added points.
Show child attributes
Show child attributes
The ID of the trigger award
The points awarded by this trigger
The date these points were awarded, in ISO 8601 format.
The user's total points after this award occurred.
Show child attributes
Show child attributes
The ID of the trigger
The type of trigger
metric, achievement, streak, time, user_creation The points awarded by this trigger.
If the trigger has type 'metric', the name of the metric
If the trigger has type 'metric', the threshold of the metric that triggers the points
If the trigger has type 'streak', the threshold of the streak that triggers the points
If the trigger has type 'achievement', the name of the achievement
If the trigger has type 'time', the unit of time after which to award points
hour, day If the trigger has type 'time', the numer of units of timeUnit after which to award points
Response
Return a 200 status to indicate the webhook was received and processed.
Was this page helpful?