Skip to main content
WEBHOOK
points.boost_finished
{
  "type": "points.boost_finished",
  "timestamp": "2025-01-17T23:59:59Z",
  "boost": {
    "id": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
    "name": "Double XP Weekend",
    "status": "finished",
    "userId": null,
    "pointsSystemId": "0040fe51-6bce-4b44-b0ad-bddc4e123535",
    "pointsSystemKey": "xp",
    "pointsSystemName": "XP",
    "start": "2025-01-15",
    "end": "2025-01-17",
    "multiplier": 2,
    "rounding": "down"
  }
}
For boosts that apply to all users or a user group, events fire between 13:00-13:59 UTC the day following the end of a boost. This is because each boost is relative to each user’s time zone, and users in the most delayed time zones must be given the chance to experience the whole duration of the boost.For user-specific boosts (boosts that only apply to one user), events fire at the exact boost finish time in that user’s time zone.

Body

application/json

The webhook event.

​
type
enum<string>
required

The webhook event type.

Available options:
points.boost_finished
​
timestamp
string<date-time>
required

When the event occurred (ISO 8601).

​
boost
PointsBoostWebhookPayload · object
required

The points boost that finished.

Response

200

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