> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Notifications API

> 알림(Notification)은 새 게시물, 결제, 멘션 등 사용자에게 전달되는 메시지입니다.

각 알림은 사용자가 속한 익스피리언스나 사용자가 소속된 팀에서 발생하며, 사용자가 환경설정을 지정하는 새 판매와 같은 토픽에 속합니다.

Notifications API를 사용하여 사용자의 피드를 조회하고, 읽지 않은 배지를 읽고 지우며, 앱에서 익스피리언스 사용자나 계정 팀에게 알림을 보내고, 알림 환경설정이 참조하는 토픽 카탈로그를 조회할 수 있습니다.

## 엔드포인트

| 엔드포인트 | 요청 |
| - | - |
| [알림 목록 조회](https://docs.whop.com/ko/api-reference/notifications/list-notifications.md) | GET `/notifications` |
| [알림 조회](https://docs.whop.com/ko/api-reference/notifications/retrieve-notification.md) | GET `/notifications/{id}` |
| [알림 배지 목록 조회](https://docs.whop.com/ko/api-reference/notifications/list-notification-badges.md) | GET `/notifications/badges` |
| [알림 토픽 목록 조회](https://docs.whop.com/ko/api-reference/notifications/list-notification-topics.md) | GET `/notifications/topics` |
| [알림 보내기](https://docs.whop.com/ko/api-reference/notifications/send-notification.md) | POST `/notifications` |
| [알림 읽음으로 표시](https://docs.whop.com/ko/api-reference/notifications/mark-notifications-read.md) | POST `/notifications/mark_read` |

## 속성

**id** `string` *required*

알림 ID입니다. 피드 행은 목록 커서로도 사용되는 복합 ID를 가집니다.

**account** `object | null` *required*

알림이 속한 계정입니다. 알림이 계정과 연결되지 않은 경우 `null`입니다.

> [accordion] 속성
>
> **id** `string` *required*
>
> 계정 ID로, 접두사는 `biz_`입니다.
>
> **logo\_url** `string | null` *required*
>
> 계정 로고 이미지 URL입니다. 계정이 로고를 업로드하지 않은 경우 `null`입니다.
>
> **route** `string | null` *required*
>
> whop.com에 있는 계정 스토어 페이지의 URL 슬러그입니다.
>
> **title** `string` *required*
>
> 계정 표시 이름입니다.

**attachment\_url** `string` *required*

알림과 함께 표시되는 이미지로, 보낸 사람의 아바타 또는 기본 알림 이미지입니다.

**content** `string` *required*

사용자에게 표시되는 알림 본문 텍스트입니다.

**created\_at** `string` *required*

알림이 생성된 시점으로, ISO 8601 타임스탬프입니다.

**experience** `object | null` *required*

알림과 관련된 익스피리언스입니다. 특정 익스피리언스와 연결되지 않은 경우 `null`입니다.

> [accordion] 속성
>
> **id** `string` *required*
>
> 익스피리언스 ID로, 접두사는 `exp_`입니다.
>
> **app** `object | null` *required*
>
> 익스피리언스가 속한 앱입니다.
>
> > [accordion] 속성
> >
> > **id** `string` *required*
> >
> > 앱 ID로, 접두사는 `app_`입니다.
> >
> > **icon\_url** `string` *required*
> >
> > 아이콘 이미지 URL입니다. 항상 존재하며, 업로드된 아이콘이 없으면 기본 앱 아이콘입니다.
>
> **name** `string | null` *required*
>
> 익스피리언스의 표시 이름입니다.

**iframe\_link** `string | null` *required*

앱 자체 도메인에 있는 동일한 대상으로, Whop 웹 및 모바일 클라이언트는 해당
대상으로 이동하는 대신 이를 임베드합니다. Whop 앱을 직접 렌더링하는 경우에만
관련이 있습니다. 알림에 자체 `link`가 있는 경우 `null`입니다.

**link** `string | null` *required*

알림이 여는 whop.com 페이지로, 일반적인 최상위 탐색으로 열립니다. Whop 앱을
직접 호스팅하지 않는 한 이 링크를 사용하세요. 알림에 클릭 시 이동할 대상이
없는 경우 `null`입니다.

**mentions\_me** `boolean` *required*

인증된 사용자가 이 알림에서 직접 멘션되었는지 여부입니다.

**rest\_path** `string | null` *required*

알림의 딥 링크에 추가되는 부가 경로 정보입니다(있는 경우).

**sender** `object | null` *required*

알림을 발생시킨 사용자입니다. 시스템에서 생성된 경우 `null`입니다.

> [accordion] 속성
>
> **id** `string` *required*
>
> 사용자 ID로, 접두사는 `user_`입니다.
>
> **name** `string | null` *required*
>
> 표시 이름입니다.
>
> **username** `string` *required*
>
> 공개 사용자 이름입니다.

**subject** `string` *required*

사용자에게 표시되는 알림의 제목 줄입니다.

**topic** `object | null` *required*

알림이 속한 토픽 카테고리로, 그룹화 및 환경설정 관리에 사용됩니다. 분류되지 않은 경우 `null`입니다.

> [accordion] 속성
>
> **id** `string` *required*
>
> 알림 토픽 ID로, 접두사는 `topic_`입니다.
>
> **default\_preference\_value** `boolean` *required*
>
> 사용자가 환경설정을 지정하지 않았을 때 이 토픽의 알림이 기본적으로
> 활성화되는지 여부입니다.
>
> **is\_mention** `boolean` *required*
>
> 이 토픽이 멘션 기반 알림만 처리하는지 여부입니다.
>
> **topic\_type** `string` *required*
>
> 토픽의 범위로, 계정, 사용자 또는 계정 팀 중 어디에 적용되는지를 나타냅니다.
>
> 사용 가능한 옵션: `account`, `user`, `account_team`

```json Notification theme={null}
{
	"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"
}
```
