Notification Center

Notification center is a feature that aggregates important notifications for users in one place. It includes various types of notifications such as friend requests, mentions, and activity updates.

Notification Center Item Object

Notification Center Item Structure
FieldTypeDescription
idsnowflakeThe ID of the notification center item
bundle_idstringAn ID that can be used to group related notification center items together
typestringThe type of notification center item
item_enum?integerThe sub-type of the notification center item (only for lifecycle_item items)
bodystringThe body text of the notification center item
ackedbooleanWhether the notification center item is acknowledged
deeplinkstringThe URL used for deep linking
icon_url 1?stringThe URL of the icon to display
icon_name 1?stringThe internal name of the icon to display
other_user?partial user objectThe other user associated with the item
message?message objectThe message associated with the item
completedbooleanWhether the item is completed
guild_id?snowflakeThe ID of the guild associated with the item
message_id?snowflakeThe ID of the message associated with the item
message_channel_id?snowflakeThe ID of the channel of the message associated with the item
guild_scheduled_event_id?snowflakeThe ID of the scheduled event associated with the item
disable_actionbooleanWhether the item is non-actionable
callout?stringAdditional information about the item (e.g. poll question)
application?partial application objectThe application associated with the item
emoji_id 2?snowflakeThe ID of the custom emoji associated with the item
emoji_name 2?stringThe unicode character of the emoji associated with the item
message_content?stringContents of the message associated with the item
message_embed_count?integerNumber of the embeds that the associated message has
message_attachment_count?integerNumber of the attachments that the associated message has
message_sticker_count?integerNumber of the stickers that the associated message has
is_voice_messagebooleanWhether the associated message is a voice message

1 Only either icon_url or icon_name may be present.

2 At most one of emoji_id and emoji_name may be set to a non-null value.

Notification Center Item Type
ValueDescription
go_live_pushFriend started a stream
friend_request_acceptedOutgoing friend request was accepted
friend_request_pendingA friend request is pending
friend_suggestion_createdA friend suggestion was created
friend_request_reminderReminder about pending friend requests
dm_friend_nudgeReminder to message friends
recent_mentionRecent mention
reply_mentionMention through a reply ping
scheduled_guild_event_startedA guild scheduled event started
system_demoDemo notification
missed_messagesMissed messages from frequently read channel
top_messages (deprecated)Top messages from a frequently read guild's home feed
lifecycle_itemNew user tutorial item
trending_contentUnknown
poll_endedPoll ended
game_friend_request_acceptedOutgoing game friend request was accepted
reaction_sentReaction was added on the user's message
Notification Center Item Enum
ValueNameDescription
0UPDATE_PROFILEUpdate profile
1FIND_FRIENDSFind friends
2ADD_FRIENDAdd friend
3FIRST_MESSAGEFirst message

Endpoints

Get Notification Center Items

GET/users/@me/notification-center/items

Returns the user's notification center items. Items are ordered by most recent first.

Query String Params
FieldTypeDescription
after?snowflakeGet notification center items after this notification center item ID
with_mentions?booleanWhether to include recent mention notifications (default false)
roles_filter?booleanWhether to include role mentions (default true)
everyone_filter?booleanWhether to include @everyone and @here mentions (default true)
limit?integerMax number of notification center items to return (1-100, default 25)
Response Body
FieldTypeDescription
limitintegerThe requested limit
itemsarray[notification center item object]The notification center items
cursor?snowflakeThe cursor for pagination
has_morebooleanWhether there are potentially additional notification center items that could be returned on a subsequent call

Delete Notification Center Item

DELETE/users/@me/notification-center/items/{notification_center_item.id}

Deletes a notification center item. Returns a 204 empty response on success. Fires a Notification Center Item Delete Gateway event.

JSON Params
FieldTypeDescription
item_type?stringThe type of notification center item to delete
Notification Center Item Deletion Type
ValueDescription
mentionThe item is a mention (type of reply_mention or recent_mention)
regularThe item is a regular item

Acknowledge Notification Center Item

POST/users/@me/notification-center/items/{notification_center_item.id}/ack

Acknowledges a notification center item. Returns a 204 empty response on success. Fires a Notification Center Items Ack Gateway event.

Bulk Acknowledge Notification Center Items

POST/users/@me/notification-center/items/bulk-ack

Acknowledges multiple notification center items in bulk. Returns a 204 empty response on success. Fires multiple Notification Center Items Ack Gateway events.

Query String Parameters
FieldTypeDescription
item_idsarray[snowflake]The IDs of the notification center items to acknowledge