Skip to main content
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

Atributos

string
requerido
ID de la notificación. Las filas del feed llevan un id compuesto que también funciona como cursor de la lista.
object | null
requerido
Cuenta a la que pertenece la notificación. null cuando la notificación no está asociada a una cuenta.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
string | null
requerido
URL de la imagen del logo de la cuenta. null cuando la cuenta no ha subido ninguno.
string | null
requerido
Slug de URL de la página de tienda de la cuenta en whop.com.
string
requerido
Nombre visible de la cuenta.
string
requerido
Imagen que se muestra junto a la notificación: el avatar del remitente o la imagen de notificación predeterminada.
string
requerido
El texto del cuerpo de la notificación que se muestra al usuario.
string
requerido
Cuándo se creó la notificación, como marca de tiempo ISO 8601.
object | null
requerido
Experiencia con la que está relacionada la notificación. null cuando no está vinculada a una experiencia específica.

Propiedades

string
requerido
ID de la experiencia, con el prefijo exp_.
object | null
requerido
App a la que pertenece la experiencia.

Propiedades

string
requerido
ID de la app, con el prefijo app_.
string
requerido
URL de la imagen del icono. Siempre presente: el icono de app predeterminado cuando no se ha subido ninguno.
string | null
requerido
Nombre visible de la experiencia.
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.
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.
boolean
requerido
Si el usuario autenticado fue mencionado directamente en esta notificación.
string | null
requerido
Información de ruta adicional que se añade al deep link de la notificación, si la hay.
object | null
requerido
Usuario que desencadenó la notificación. null cuando la generó el sistema.

Propiedades

string
requerido
ID del usuario, con el prefijo user_.
string | null
requerido
Nombre visible.
string
requerido
Nombre de usuario público.
string
requerido
La línea de título de la notificación que se muestra al usuario.
object | null
requerido
Categoría de tema a la que pertenece la notificación, usada para agrupar y gestionar preferencias. null cuando no tiene categoría.

Propiedades

string
requerido
ID del tema de notificación, con el prefijo topic_.
boolean
requerido
Si las notificaciones de este tema están activadas por defecto cuando el usuario no ha establecido una preferencia.
boolean
requerido
Si este tema gestiona exclusivamente notificaciones basadas en menciones.
string
requerido
Alcance del tema: si se aplica a una cuenta, a un usuario o al equipo de una cuenta.Opciones disponibles: account, user, account_team
Notification