Skip to main content
WEBHOOK
points.boost_started
{
  "type": "points.boost_started",
  "timestamp": "2025-01-15T00:00:00Z",
  "boost": {
    "id": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
    "name": "Double XP Weekend",
    "status": "active",
    "userId": null,
    "pointsSystemId": "0040fe51-6bce-4b44-b0ad-bddc4e123535",
    "pointsSystemKey": "xp",
    "pointsSystemName": "XP",
    "start": "2025-01-15",
    "end": "2025-01-17",
    "multiplier": 2,
    "rounding": "down"
  }
}

Body

application/json

The webhook event.

​
type
enum<string>
required

The webhook event type.

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

When the event occurred (ISO 8601).

​
boost
PointsBoostWebhookPayload · object
required

The points boost that started.

Response

200

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