Skip to main content
Chacune provient d’une expérience à laquelle l’utilisateur appartient ou d’une équipe dont il fait partie, et relève d’un sujet, comme les nouvelles ventes, pour lequel les utilisateurs définissent des préférences. Utilisez l’API Notifications pour lister le fil d’un utilisateur, lire et effacer les badges non lus, envoyer des notifications depuis votre app aux utilisateurs d’une expérience ou à l’équipe d’un compte, et lister le catalogue de sujets auquel font référence les préférences de notification.

Endpoints

Attributs

string
requis
ID de la notification. Les lignes du fil portent un id composite qui sert également de curseur de liste.
object | null
requis
Compte auquel appartient la notification. null lorsque la notification n’est associée à aucun compte.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string | null
requis
URL de l’image du logo du compte. null lorsque le compte n’en a pas téléversé.
string | null
requis
Slug d’URL de la page boutique du compte sur whop.com.
string
requis
Nom d’affichage du compte.
string
requis
Image affichée à côté de la notification — l’avatar de l’expéditeur, ou l’image de notification par défaut.
string
requis
Le corps du texte de la notification affiché à l’utilisateur.
string
requis
Date de création de la notification, sous forme d’horodatage ISO 8601.
object | null
requis
Expérience à laquelle la notification est liée. null lorsqu’elle n’est liée à aucune expérience spécifique.

Propriétés

string
requis
ID de l’expérience, préfixé par exp_.
object | null
requis
App à laquelle appartient l’expérience.

Propriétés

string
requis
ID de l’app, préfixé par app_.
string
requis
URL de l’image de l’icône. Toujours présente — l’icône d’app par défaut lorsqu’aucune n’a été téléversée.
string | null
requis
Nom d’affichage de l’expérience.
La même destination sur le propre domaine de l’app, que les clients web et mobile de Whop intègrent au lieu d’y naviguer. Pertinent uniquement si vous affichez vous-même des apps Whop. null lorsque la notification porte son propre link.
La page whop.com que la notification ouvre, sous forme de navigation de premier niveau classique. C’est le lien à utiliser, sauf si vous hébergez vous-même des apps Whop. null lorsque la notification n’a pas de destination au clic.
boolean
requis
Indique si l’utilisateur authentifié a été directement mentionné dans cette notification.
string | null
requis
Informations de chemin supplémentaires ajoutées au lien profond de la notification, le cas échéant.
object | null
requis
Utilisateur qui a déclenché la notification. null lorsqu’elle a été générée par le système.

Propriétés

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
string
requis
Nom d’utilisateur public.
string
requis
La ligne de titre de la notification affichée à l’utilisateur.
object | null
requis
Catégorie de sujet à laquelle appartient la notification, utilisée pour le regroupement et la gestion des préférences. null lorsqu’elle n’est pas catégorisée.

Propriétés

string
requis
ID du sujet de notification, préfixé par topic_.
boolean
requis
Indique si les notifications de ce sujet sont activées par défaut lorsque l’utilisateur n’a pas défini de préférence.
boolean
requis
Indique si ce sujet gère exclusivement les notifications basées sur des mentions.
string
requis
Portée du sujet : indique s’il s’applique à un compte, à un utilisateur ou à l’équipe d’un compte.Options disponibles : account, user, account_team
Notification