keii.dev / osu-web
the browser-facing portion of osu!
fork atom
osu-web / resources / views / docs / _structures / notification.md
at master 9.4 kB view raw view code

Notification#

{
  "id": 1,
  "name": "channel_message",
  "created_at": "2019-04-24T07:12:43+00:00",
  "object_type": "channel",
  "object_id": 1,
  "source_user_id": 1,
  "is_read": true,
  "details": {
    "username": "someone",
    ...
  }
}

Represents a notification object.

Field Type Description
id integer
name string Name of the event
created_at Timestamp ISO 8601 date
object_type string
object_id integer
source_user_id integer?
is_read boolean
details object message_id of last known message (only returned in presence responses)

Event Names#

Name Description
beatmapset_discussion_lock Discussion on beatmap has been locked
beatmapset_discussion_post_new New discussion post on beatmap
beatmapset_discussion_unlock Discussion on beatmap has been unlocked
beatmapset_disqualify Beatmap was disqualified
beatmapset_love Beatmap was promoted to loved
beatmapset_nominate Beatmap was nominated
beatmapset_qualify Beatmap has gained enough nominations and entered the ranking queue
beatmapset_remove_from_loved Beatmap was removed from Loved
beatmapset_reset_nominations Nomination of beatmap was reset
channel_message Someone sent chat message
forum_topic_reply Someone replied on forum topic

beatmapset_discussion_lock#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer User who locked discussion

Details object:

Field Type Description
cover_url string Beatmap cover
title string Beatmap title
username string Username of source_user_id

beatmapset_discussion_post_new#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer Poster of the discussion

Details object:

Field Type Description
title string Beatmap title
cover_url string Beatmap cover
discussion_id integer
post_id integer
beatmap_id integer? null if posted to general all
username string Username of source_user_id

beatmapset_discussion_unlock#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer User who unlocked discussion

Details object:

Field Type Description
title string Beatmap title
cover_url string Beatmap cover
username string Username of source_user_id

beatmapset_disqualify#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer User who disqualified beatmapset

Details object:

Field Type Description
title string Beatmap title
cover_url string Beatmap cover
username string Username of source_user_id

beatmapset_love#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer User who promoted beatmapset to loved

Details object:

Field Type Description
title string Beatmap title
cover_url string Beatmap cover
username string Username of source_user_id

beatmapset_nominate#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer User who nominated beatmapset

Details object:

Field Type Description
title string Beatmap title
cover_url string Beatmap cover
username string Username of source_user_id

beatmapset_qualify#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer User whom beatmapset nomination triggered qualification

Details object:

Field Type Description
title string Beatmap title
cover_url string Beatmap cover
username string Username of source_user_id

beatmapset_remove_from_loved#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer User who removed beatmapset from Loved

Details object:

Field Type Description
title string Beatmap title
cover_url string Beatmap cover
username string Username of source_user_id

beatmapset_reset_nominations#

Field Type Description
object_id integer Beatmapset id
object_type string beatmapset
source_user_id integer User who triggered nomination reset

Details object:

Field Type Description
title string Beatmap title
cover_url string Beatmap cover
username string Username of source_user_id

channel_message#

Field Type Description
object_id integer Channel id
object_type string channel
source_user_id integer User who posted message

Details object:

Field Type Description
title string Up to 36 characters of the message (ends with ... when exceeding 36 characters)
cover_url string Avatar of source_user_id
username string Username of source_user_id

forum_topic_reply#

Field Type Description
object_id integer Topic id
object_type string forum_topic
source_user_id integer User who posted message

Details object:

Field Type Description
title string Title of the replied topic
cover_url string Topic cover
post_id integer Post id
username string? Username of source_user_id