Skip to main content
WEBHOOK
achievement.completed
{
  "type": "achievement.completed",
  "user": {
    "id": "user-id",
    "email": "[email protected]",
    "tz": "Europe/London",
    "subscribedToEmails": true,
    "created": "2021-01-01T00:00:00Z",
    "updated": "2021-01-01T00:00:00Z",
    "attributes": {
      "department": "engineering",
      "role": "developer"
    }
  },
  "achievement": {
    "id": "d01dcbcb-d51e-4c12-b054-dc811dcdc625",
    "name": "Completed Onboarding",
    "trigger": "api",
    "description": null,
    "key": "completed-onboarding",
    "achievedAt": "2021-01-01T00:00:00Z",
    "badgeUrl": "https://example.com/badge2.png"
  }
}
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.

​
achievement
UserAchievementResponse · object
required

The achievement completion that occurred.

Response

200

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