> ## 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.

# API de Notifications

> Una Notification es un mensaje entregado a un usuario, como una nueva publicación, un pago o una mención.

Cada una proviene de una experiencia a la que pertenece el usuario o de un equipo del que forma parte, y se clasifica en un tema, como nuevas ventas, sobre el que los usuarios establecen preferencias.

Usa la API de Notifications para listar el feed de un usuario, leer y borrar los indicadores de no leídos, enviar notificaciones desde tu app a los usuarios de una experiencia o al equipo de una cuenta, y listar el catálogo de temas al que hacen referencia las preferencias de notificación.

## Endpoints

| Endpoint | Solicitud |
| - | - |
| [Listar notificaciones](https://docs.whop.com/es/api-reference/notifications/list-notifications.md) | GET `/notifications` |
| [Recuperar notificación](https://docs.whop.com/es/api-reference/notifications/retrieve-notification.md) | GET `/notifications/{id}` |
| [Listar indicadores de notificaciones](https://docs.whop.com/es/api-reference/notifications/list-notification-badges.md) | GET `/notifications/badges` |
| [Listar temas de notificaciones](https://docs.whop.com/es/api-reference/notifications/list-notification-topics.md) | GET `/notifications/topics` |
| [Enviar notificación](https://docs.whop.com/es/api-reference/notifications/send-notification.md) | POST `/notifications` |
| [Marcar notificaciones como leídas](https://docs.whop.com/es/api-reference/notifications/mark-notifications-read.md) | POST `/notifications/mark_read` |

## Atributos

**id** `string` *required*

ID de la notificación. Las filas del feed llevan un id compuesto que también funciona como cursor de la lista.

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

Cuenta a la que pertenece la notificación. `null` cuando la notificación no está asociada a una cuenta.

> [accordion] Propiedades
>
> **id** `string` *required*
>
> ID de la cuenta, con el prefijo `biz_`.
>
> **logo\_url** `string | null` *required*
>
> URL de la imagen del logo de la cuenta. `null` cuando la cuenta no ha subido ninguno.
>
> **route** `string | null` *required*
>
> Slug de URL de la página de tienda de la cuenta en whop.com.
>
> **title** `string` *required*
>
> Nombre visible de la cuenta.

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

Imagen que se muestra junto a la notificación: el avatar del remitente o la imagen de notificación predeterminada.

**content** `string` *required*

El texto del cuerpo de la notificación que se muestra al usuario.

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

Cuándo se creó la notificación, como marca de tiempo ISO 8601.

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

Experiencia con la que está relacionada la notificación. `null` cuando no está vinculada a una experiencia específica.

> [accordion] Propiedades
>
> **id** `string` *required*
>
> ID de la experiencia, con el prefijo `exp_`.
>
> **app** `object | null` *required*
>
> App a la que pertenece la experiencia.
>
> > [accordion] Propiedades
> >
> > **id** `string` *required*
> >
> > ID de la app, con el prefijo `app_`.
> >
> > **icon\_url** `string` *required*
> >
> > URL de la imagen del icono. Siempre presente: el icono de app predeterminado cuando no se ha subido ninguno.
>
> **name** `string | null` *required*
>
> Nombre visible de la experiencia.

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

El mismo destino en el dominio propio de la app, que los clientes web y móviles de Whop incrustan en lugar de navegar hasta él. Solo es relevante si tú mismo renderizas apps de Whop. `null` cuando la notificación lleva su propio `link`.

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

La página de whop.com que abre la notificación, como una navegación normal de nivel superior. Este es el enlace que debes usar, salvo que tú mismo alojes apps de Whop. `null` cuando la notificación no tiene un destino al hacer clic.

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

Si el usuario autenticado fue mencionado directamente en esta notificación.

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

Información de ruta adicional que se añade al deep link de la notificación, si la hay.

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

Usuario que desencadenó la notificación. `null` cuando la generó el sistema.

> [accordion] Propiedades
>
> **id** `string` *required*
>
> ID del usuario, con el prefijo `user_`.
>
> **name** `string | null` *required*
>
> Nombre visible.
>
> **username** `string` *required*
>
> Nombre de usuario público.

**subject** `string` *required*

La línea de título de la notificación que se muestra al usuario.

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

Categoría de tema a la que pertenece la notificación, usada para agrupar y gestionar preferencias. `null` cuando no tiene categoría.

> [accordion] Propiedades
>
> **id** `string` *required*
>
> ID del tema de notificación, con el prefijo `topic_`.
>
> **default\_preference\_value** `boolean` *required*
>
> Si las notificaciones de este tema están activadas por defecto cuando el usuario no ha establecido una preferencia.
>
> **is\_mention** `boolean` *required*
>
> Si este tema gestiona exclusivamente notificaciones basadas en menciones.
>
> **topic\_type** `string` *required*
>
> Alcance del tema: si se aplica a una cuenta, a un usuario o al equipo de una cuenta.
>
> Opciones disponibles: `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"
}
```


## Related topics

- [API de Users](https://docs.whop.com/es/api-reference/users/user.md)
- [Estabilidad de la API](https://docs.whop.com/es/api-reference/stability.md)
- [Descripción general de la API de Whop](https://docs.whop.com/es/api-reference/overview.md)
