Skip to main content
Elke notificatie komt van een experience waartoe de gebruiker behoort of van een team waarin de gebruiker zit, en valt onder een topic, zoals nieuwe verkopen, waarvoor gebruikers voorkeuren instellen. Gebruik de Notifications API om de feed van een gebruiker op te vragen, ongelezen badges te lezen en te wissen, notificaties vanuit je app naar de gebruikers van een experience of het team van een account te sturen, en de topiccatalogus op te vragen waarnaar notificatievoorkeuren verwijzen.

Endpoints

Attributen

string
vereist
Notification-ID. Feedrijen hebben een samengestelde id die ook dienstdoet als cursor voor de lijst.
object | null
vereist
Account waartoe de notificatie behoort. null wanneer de notificatie niet aan een account is gekoppeld.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
string | null
vereist
URL van de logo-afbeelding van het account. null wanneer het account er geen heeft geüpload.
string | null
vereist
URL-slug van de winkelpagina van het account op whop.com.
string
vereist
Weergavenaam van het account.
string
vereist
Afbeelding die naast de notificatie wordt getoond — de avatar van de afzender, of de standaard notificatieafbeelding.
string
vereist
De hoofdtekst van de notificatie die aan de gebruiker wordt getoond.
string
vereist
Wanneer de notificatie is aangemaakt, als ISO 8601-tijdstempel.
object | null
vereist
Experience waarop de notificatie betrekking heeft. null wanneer deze niet aan een specifieke experience is gekoppeld.

Eigenschappen

string
vereist
Experience-ID, met prefix exp_.
object | null
vereist
App waartoe de experience behoort.

Eigenschappen

string
vereist
App-ID, met prefix app_.
string
vereist
URL van de pictogramafbeelding. Altijd aanwezig — het standaard app-pictogram wanneer er geen is geüpload.
string | null
vereist
Weergavenaam van de experience.
Dezelfde bestemming op het eigen domein van de app, die de web- en mobiele clients van Whop insluiten in plaats van ernaartoe te navigeren. Alleen relevant als je Whop-apps zelf rendert. null wanneer de notificatie een eigen link heeft.
De whop.com-pagina die de notificatie opent, als normale top-level navigatie. Dit is de link die je gebruikt, tenzij je Whop-apps zelf host. null wanneer de notificatie geen doorklikbestemming heeft.
boolean
vereist
Of de geauthenticeerde gebruiker rechtstreeks in deze notificatie is vermeld.
string | null
vereist
Aanvullende padinformatie die aan de deep link van de notificatie wordt toegevoegd, indien aanwezig.
object | null
vereist
Gebruiker die de notificatie heeft geactiveerd. null wanneer deze door het systeem is gegenereerd.

Eigenschappen

string
vereist
User-ID, met prefix user_.
string | null
vereist
Weergavenaam.
string
vereist
Openbare gebruikersnaam.
string
vereist
De titelregel van de notificatie die aan de gebruiker wordt getoond.
object | null
vereist
Topiccategorie waartoe de notificatie behoort, gebruikt voor groepering en voorkeurenbeheer. null wanneer niet gecategoriseerd.

Eigenschappen

string
vereist
Notification topic-ID, met prefix topic_.
boolean
vereist
Of notificaties voor dit topic standaard zijn ingeschakeld wanneer de gebruiker geen voorkeur heeft ingesteld.
boolean
vereist
Of dit topic uitsluitend notificaties op basis van vermeldingen afhandelt.
string
vereist
Bereik van het topic: of het van toepassing is op een account, een gebruiker of het team van een account.Beschikbare opties: account, user, account_team
Notification