Sign in
latestOpenAPI 3.1.02026-08-153864115.7 MB

c301132dbfd7

Notifications

Retrieve Notification

Retrieves a single notification by id — either an id returned by List Notifications, or the ephemeral id delivered with a push/websocket event. Requires a user credential.

get/notifications/{id}

Path parameters

idstring required

A notification id from List Notifications, or the id delivered with a push/websocket event.

Response

notification found

attachment_urlstring required

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

contentstring required

The body text of the notification displayed to the user.

created_atstring required

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

idstring required

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

iframe_linkstring nullable 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.

linkstring nullable 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.

mentions_meboolean required

Whether the authenticated user was directly mentioned in this notification.

rest_pathstring nullable required

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

subjectstring required

The title line of the notification displayed to the user.

Example response

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "route": "shine-time-auto-detailing",
    "title": "Shine Time Auto Detailing"
  },
  "attachment_url": "https://ui-avatars.com/api/",
  "content": "Tuesday 9:00 AM, Bay 2",
  "created_at": "2026-01-01T12:00:00.000Z",
  "experience": {
    "app": {
      "icon_url": "https://pub-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.r2.dev/custom-perk-icon.svg",
      "id": "app_xxxxxxxxxxxxxx"
    },
    "id": "exp_xxxxxxxxxxxxxx",
    "name": "Bookings"
  },
  "id": "ntfr_xxxxxxxxxxxxxx:xxxxxxxxxxxxx",
  "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/",
  "rest_path": "/bookings/upcoming",
  "sender": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Tanya Cole",
    "username": "tanyacole"
  },
  "subject": "Your ceramic coating is booked",
  "topic": {
    "default_preference_value": true,
    "id": "topic_xxxxxxxxxxxxxx",
    "topic_type": "user"
  }
}