Notification - Whop Docs

A Notification is a message delivered to a user, such as a new post, a payment, or a mention. Each one comes from an experience the user belongs to or a team they are on, and falls under a topic, like new sales, that users set preferences on. Use the Notifications API to list a user’s feed, read and clear unread badges, send notifications from your app to an experience’s users or an account’s team, and list the topic catalog that notification preferences reference.

Endpoints

Endpoint	Request
List Notifications	GET `/notifications`
Retrieve Notification	GET `/notifications/{id}`
List Notification Badges	GET `/notifications/badges`
List Notification Topics	GET `/notifications/topics`
Send Notification	POST `/notifications`
Mark Notifications Read	POST `/notifications/mark_read`

Attributes

string

required

Notification ID. Feed rows carry a composite id that doubles as the list cursor.

object | null

required

Account the notification belongs to. null when the notification is not associated with an account.

Properties

string

required

Account ID, prefixed biz_.

string | null

required

Account logo image URL. null when the account has not uploaded one.

string | null

required

URL slug of the account’s store page on whop.com.

string

required

Account display name.

string

required

Image displayed alongside the notification — the sender’s avatar, or the default notification image.

string

required

The body text of the notification displayed to the user.

string

required

When the notification was created, as an ISO 8601 timestamp.

object | null

required

Experience the notification is related to. null when not tied to a specific experience.

Properties

string

required

Experience ID, prefixed exp_.

object | null

required

App the experience belongs to.

Properties

string

required

App ID, prefixed app_.

string

required

Icon image URL. Always present — the default app icon when none is uploaded.

string | null

required

Display name of the experience.

string | null

required

The same destination on the app’s own domain, which the Whop web and mobile clients embed instead of navigating to it. Only relevant if you render Whop apps yourself. null when the notification carries its own link.

string | null

required

The whop.com page the notification opens, as a normal top-level navigation. This is the link to use unless you host Whop apps yourself. null when the notification has no click-through destination.

boolean

required

Whether the authenticated user was directly mentioned in this notification.

string | null

required

Additional path information appended to the notification’s deep link, if any.

object | null

required

User who triggered the notification. null when it was system-generated.

Properties

string

required

User ID, prefixed user_.

string | null

required

Display name.

string

required

Public username.

string

required

The title line of the notification displayed to the user.

object | null

required

Topic category the notification belongs to, used for grouping and preference management. null when uncategorized.

Properties

string

required

Notification topic ID, prefixed topic_.

boolean

required

Whether notifications for this topic are enabled by default when the user has not set a preference.

boolean

required

Whether this topic exclusively handles mention-based notifications.

string

required

Scope of the topic: whether it applies to an account, a user, or an account’s team.Available options: account, user, account_team

Notification

{
	"id": "ntfr_xxxxxxxxxxxxxx:xxxxxxxxxxxxx",
	"account": {
		"id": "biz_xxxxxxxxxxxxxx",
		"logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		"route": "shine-time-auto-detailing",
		"title": "Shine Time Auto Detailing"
	},
	"content": "Tuesday 9:00 AM, Bay 2",
	"created_at": "2026-09-15T14:30:00.000Z",
	"experience": {
		"id": "exp_xxxxxxxxxxxxxx",
		"app": {
			"id": "app_xxxxxxxxxxxxxx",
			"icon_url": "https://pub-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.r2.dev/custom-perk-icon.svg"
		},
		"name": "Bookings"
	},
	"iframe_link": "https://whopappdomain0000001.apps.whop.com/experiences/exp_xxxxxxxxxxxxxx/bookings/upcoming",
	"link": "https://whop.com/joined/shine-time-auto-detailing/bookings-xxxxxxxxxxxxxx/app/bookings/upcoming/",
	"mentions_me": false,
	"rest_path": "/bookings/upcoming",
	"sender": {
		"id": "user_xxxxxxxxxxxxxx",
		"name": "Tanya Cole",
		"username": "tanyacole"
	},
	"subject": "Your ceramic coating is booked",
	"topic": {
		"id": "topic_xxxxxxxxxxxxxx",
		"default_preference_value": true,
		"is_mention": false,
		"topic_type": "user"
	},
	"attachment_url": "https://ui-avatars.com/api/?name=Tanya+Cole"
}

​Endpoints

​Attributes

Endpoints

Attributes