Skip to main content
WEBHOOK
points.changed
{
  "type": "points.changed",
  "user": {
    "id": "user-id",
    "email": "user@example.com",
    "tz": "Europe/London",
    "subscribedToEmails": true,
    "created": "2021-01-01T00:00:00Z",
    "updated": "2021-01-01T00:00:00Z",
    "attributes": {
      "department": "engineering",
      "role": "developer"
    }
  },
  "points": {
    "id": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
    "key": "xp",
    "name": "XP",
    "description": null,
    "badgeUrl": null,
    "maxPoints": null,
    "total": 100,
    "awards": [
      {
        "id": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
        "awarded": 10,
        "date": "2021-01-01T00:00:00Z",
        "total": 100,
        "trigger": {
          "id": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
          "type": "metric",
          "points": 10,
          "metricName": "words written",
          "metricThreshold": 1000
        }
      }
    ]
  }
}
Does not apply to user identification trigger type.

Body

application/json

The webhook event.

​
type
enum<string>
required

The webhook event type.

Available options:
points.changed
​
user
object
required

The user whose points increased or decreased.

​
points
object
required

The user's points after the event.

Response

200

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