Event Types

Upon successful connection, you will receive a connected event. After that, you may receive any of the following event types:

connected

Sent immediately after subscribing. Confirms the connection is established.

loyalty_update

Sent when the user's XP or level changes.
Data payload:
FieldTypeDescription
user_id
int
User ID
level
int
New level number
xp
float
Current XP amount

vc_update

Sent when the user's virtual currency balance changes.
Data payload:
FieldTypeDescription
user_id
int
User ID
virtual_currency_id
int
ID of the virtual currency
new_amount
float
New balance amount

wheel_tokens_update

Sent when wheel tokens are credited or debited.
Data payload:
FieldTypeDescription
user_id
int
User ID
wheel_id
int
ID of the wheel
transaction_type
string
"credit" or "debit"
expire_date
string
ISO 8601 expiration date (optional, for credits)

challenges_progress_update

Sent when progress is made on a challenge task.
Data payload:
FieldTypeDescription
user_id
int
User ID
user_task_id
int
ID of the user's task instance
amount
float
Current progress amount

challenges_credit_update

Sent when a challenge is completed or a milestone is reached.
Data payload: Full Challenge object (see GraphQL schema for structure).

bonus_update

Sent when a bonus is awarded to the user.
Data payload: Full UserBonusV2 object (see GraphQL schema for structure).