Achievement completed

This webhook doesn’t fire for achievements that are backdated.

Body

application/json

The webhook event.

type

enum<string>

required

The webhook event type.

Available options:

achievement.completed

user

User · object

required

The user who completed the achievement.

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"

achievement

CompletedAchievementResponse · object

required

The achievement completion that occurred.

Show child attributes

achievement.id

string

required

The unique ID of the achievement.

achievement.name

string

required

The name of this achievement.

achievement.trigger

enum<string>

required

The trigger of the achievement.

Available options:

metric,

streak,

api

achievement.description

string | null

required

The description of this achievement.

achievement.badgeUrl

string | null

required

The URL of the badge image for the achievement, if one has been uploaded.

achievement.key

string

required

The key used to reference this achievement in the API (only applicable if trigger = 'api')

achievement.achievedAt

string<date-time> | null

required

The date and time the achievement was completed, in ISO 8601 format. Null if the achievement has not been completed.

achievement.streakLength

integer

The length of the streak required to complete the achievement (only applicable if trigger = 'streak')

achievement.metricId

string

The ID of the metric associated with this achievement (only applicable if trigger = 'metric')

achievement.metricValue

number<double>

The value of the metric required to complete the achievement (only applicable if trigger = 'metric')

achievement.metricName

string

The name of the metric associated with this achievement (only applicable if trigger = 'metric')

Response

200

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

Overview

Achievements

Streaks

Points

Leaderboards

Achievement completed

Body

Response