resources/views/docs/_structures/event.md at master · keii.dev/osu-web

Event#

The object has different attributes depending on its type. Following are attributes available to all types.

Field	Type	Description
created_at	Timestamp
id	integer
type	Event.Type

Additional objects#

Beatmap#

Field	Type
title	string
url	string

Beatmapset#

Field	Type
title	string
url	string

User#

Field	Type	Description
username	string
url	string
previousUsername	string?	Only for `usernameChange` event.

Available Types#

achievement#

When user obtained an achievement.

Field	Type
achievement	Achievement
user	Event.User

beatmapPlaycount#

When a beatmap has been played for certain number of times.

Field	Type
beatmap	Event.Beatmap
count	integer

beatmapsetApprove#

When a beatmapset changes state.

Field	Type	Description
approval	string	`ranked`, `approved`, `qualified`, `loved`.
beatmapset	Event.Beatmapset
user	Event.User	Beatmapset owner.

beatmapsetDelete#

When a beatmapset is deleted.

Field	Type
beatmapset	Event.Beatmapset

beatmapsetRevive#

When a beatmapset in graveyard state is updated.

Field	Type	Description
beatmapset	Event.Beatmapset
user	Event.User	Beatmapset owner.

beatmapsetUpdate#

When a beatmapset is updated.

Field	Type	Description
beatmapset	Event.Beatmapset
user	Event.User	Beatmapset owner.

beatmapsetUpload#

When a new beatmapset is uploaded.

Field	Type	Description
beatmapset	Event.Beatmapset
user	Event.User	Beatmapset owner.

rank#

When a user achieves a certain rank on a beatmap.

Field	Type	Description
scoreRank	string	(FIXME)
rank	integer
mode	Ruleset
beatmap	Event.Beatmap
user	Event.User

rankLost#

When a user loses first place to another user.

Field	Type
mode	Ruleset
beatmap	Event.Beatmap
user	Event.User

userSupportAgain#

When a user supports osu! for the second and onwards.

Field	Type
user	Event.User

userSupportFirst#

When a user becomes a supporter for the first time.

Field	Type
user	Event.User

userSupportGift#

When a user is gifted a supporter tag by another user.

Field	Type	Description
user	Event.User	Recipient user.

usernameChange#

When a user changes their username.

Field	Type	Description
user	Event.User	Includes `previousUsername`.