Skip to main content
Hver notifikation kommer fra en experience, som brugeren tilhører, eller et team, de er med i, og hører under et emne, såsom nye salg, som brugere kan angive præferencer for. Brug Notifications API’et til at vise en brugers feed, læse og rydde ulæste badges, sende notifikationer fra din app til en experiences brugere eller en kontos team og vise emnekataloget, som notifikationspræferencer refererer til.

Endpoints

Attributter

string
påkrævet
Notifikations-ID. Feed-rækker har et sammensat id, der også fungerer som listens cursor.
object | null
påkrævet
Kontoen, som notifikationen tilhører. null, når notifikationen ikke er knyttet til en konto.

Egenskaber

string
påkrævet
Konto-ID med præfikset biz_.
string | null
påkrævet
URL til kontoens logobillede. null, når kontoen ikke har uploadet et.
string | null
påkrævet
URL-slug for kontoens butiksside på whop.com.
string
påkrævet
Kontoens visningsnavn.
string
påkrævet
Billede, der vises sammen med notifikationen — afsenderens avatar eller standardbilledet for notifikationer.
string
påkrævet
Notifikationens brødtekst, der vises for brugeren.
string
påkrævet
Hvornår notifikationen blev oprettet, som et ISO 8601-tidsstempel.
object | null
påkrævet
Experiencen, som notifikationen vedrører. null, når den ikke er knyttet til en bestemt experience.

Egenskaber

string
påkrævet
Experience-ID med præfikset exp_.
object | null
påkrævet
Appen, som experiencen tilhører.

Egenskaber

string
påkrævet
App-ID med præfikset app_.
string
påkrævet
URL til ikonbillede. Altid til stede — standardapp-ikonet, når der ikke er uploadet et.
string | null
påkrævet
Experiencens visningsnavn.
Samme destination på appens eget domæne, som Whops web- og mobilklienter indlejrer i stedet for at navigere til den. Kun relevant, hvis du selv renderer Whop-apps. null, når notifikationen har sit eget link.
Den whop.com-side, notifikationen åbner, som en normal navigation på øverste niveau. Det er dette link, du skal bruge, medmindre du selv hoster Whop-apps. null, når notifikationen ikke har nogen klikdestination.
boolean
påkrævet
Om den godkendte bruger blev omtalt direkte i denne notifikation.
string | null
påkrævet
Yderligere stiinformation, der tilføjes til notifikationens deep link, hvis der er nogen.
object | null
påkrævet
Brugeren, der udløste notifikationen. null, når den er systemgenereret.

Egenskaber

string
påkrævet
Bruger-ID med præfikset user_.
string | null
påkrævet
Visningsnavn.
string
påkrævet
Offentligt brugernavn.
string
påkrævet
Notifikationens titellinje, der vises for brugeren.
object | null
påkrævet
Emnekategorien, som notifikationen tilhører, bruges til gruppering og administration af præferencer. null, når den ikke er kategoriseret.

Egenskaber

string
påkrævet
Notifikationsemne-ID med præfikset topic_.
boolean
påkrævet
Om notifikationer for dette emne er slået til som standard, når brugeren ikke har angivet en præference.
boolean
påkrævet
Om dette emne udelukkende håndterer omtalebaserede notifikationer.
string
påkrævet
Emnets omfang: om det gælder for en konto, en bruger eller en kontos team.Tilgængelige muligheder: account, user, account_team
Notification