Skip to main content
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis v1.0.0. Se monte à l’intérieur de Websites. Transmettez les props et les callbacks via les options de création ou les props React.
Vous pouvez monter cet élément inline (create) ou l’ouvrir sous forme d’overlay modal (createOverlay).

Données d’exemple. Ouvrir le Playground.

Props

string
ID du compte, préfixé biz_, auquel appartient ce pixel. Obligatoire ; le snippet, les analyses et les invitations s’exécutent tous sur ce compte. Par défaut : "".
string
Un jeton à portée limitée pour les analyses et l’invitation de développeur. Les analyses nécessitent company:basic:read ; « Invite a developer » nécessite en plus authorized_user:create, et les préréglages d’événements lisent le compte avec company:balance:read (sans ce scope, l’assistant fonctionne quand même, avec une liste de préréglages générique). Lorsqu’aucune destinationUrl n’est transmise, le champ d’URL vide suggère aussi des pages issues des annonces et du trafic pixel du compte — ces lectures nécessitent ad_campaign:basic:read et stats:read, et sans elles le champ reste simplement vide. Générez-le sur votre serveur avec POST /api/v1/access_tokens et définissez-en un nouveau avant son expiration. Un autre élément qui ouvre cet assistant en son sein — comme le fait le campaign-creator des annonces — exécute ces appels avec son propre jeton : ajoutez donc ces scopes à cet unique jeton plutôt que d’en générer un second, car cet élément n’a aucun moyen de lire un identifiant défini ailleurs. S’il est omis, les appels utilisent la session du spectateur, qui ne répond qu’en same-origin.
string
La page à vérifier, analysée au montage. Laissez-la vide et l’assistant en demandera une. C’est aussi ce qui conditionne « Verify live » à l’étape des événements — ce bouton guide le propriétaire du compte à travers son propre funnel pour capter les événements qu’une analyse côté serveur ne peut pas voir, il n’apparaît donc qu’une fois une destination connue, définie ici ou indiquée dans l’assistant. Lue une seule fois au démarrage, donc update() ne changera pas de cible en cours de parcours — créez un nouveau montage pour une autre page. Par défaut : "".
string
Facultatif. Un événement qui doit se déclencher sur cette page (lead, schedule, view_content, …) ; l’étape des événements reste bloquée jusqu’à ce qu’il soit détecté. S’il n’est pas défini, tous les événements sont proposés et aucun n’est obligatoire. Les événements que Whop enregistre côté serveur (purchase, subscribe, essais, étapes de checkout) sont ignorés. Lu une seule fois au démarrage. Par défaut : "".
string
Une URL vers laquelle la destination redirige, lorsque l’événement s’y déclenche à la place. Le propriétaire du compte peut aussi en définir une dans l’assistant — écoutez redirectUrlChanged et renvoyez-la la fois suivante. Par défaut : "".
"events" | "install"
L’étape à laquelle l’assistant s’ouvre : l’étape d’installation, ou directement events lorsque le pixel est déjà présent et que seul l’événement de conversion manque. Par défaut : "install".
boolean
S’ouvrir sur l’écran d’accueil « pourquoi un pixel ». Désactivez-le lorsque le propriétaire du compte sait déjà pourquoi il est là — un parcours de campagne qui l’y envoie en plein lancement — et l’assistant s’ouvre directement sur l’étape d’installation. Par défaut : true.
boolean
Proposer l’option « Invite a developer to install it ». Masquez-la lorsque les personnes utilisant votre intégration ne doivent pas inviter de membres dans l’équipe Whop qui se trouve derrière. Par défaut : true.
boolean
Afficher l’écran « your pixel is live » après la validation d’une page, qui propose les événements de conversion comme étape suivante. Désactivez-le lorsque le propriétaire du compte est venu pour les événements eux-mêmes — une vérification réussie y mène alors directement au lieu de s’arrêter sur un écran qu’il passerait d’un clic. Par défaut : true.
boolean
Commencer par la vérification de la page plutôt que par les instructions d’installation : le champ d’URL (et ses suggestions) se trouve en haut, les options d’installation sont repliées sous un bouton « Pixel not installed yet? », et l’en-tête indique « Verify your pixel ». Destiné à un propriétaire de compte qui a déjà un pixel et cherche à comprendre pourquoi rien n’est attribué. Associez-le à showIntro: false. Par défaut : false.

Événements

Transmettez les callbacks dans les options de création ou dans les props React.

onRedirectUrlChanged

Le propriétaire du compte a défini ou effacé une URL de redirection dans l’assistant. Enregistrez-la et renvoyez-la en tant que redirectUrl la fois suivante.
object

onScanned

Une analyse du pixel s’est terminée. Se déclenche pour chaque URL que l’assistant vérifie, afin que votre propre badge d’installation puisse la suivre. primary indique la page en cours de configuration : le vérificateur de funnel analyse tout ce que le propriétaire du compte liste d’autre, y compris d’autres noms d’hôte, alors filtrez sur ce champ avant de considérer qu’un résultat concerne son site. Vous n’en avez pas besoin pour garder un tableau websites à jour — monté sous ce handle, un site dont la mise en ligne est prouvée obtient déjà sa ligne en attente.
object

onFinished

« Done » a été pressé. Revérifiez la page vous-même — cela indique que l’assistant est terminé, pas que vos exigences sont remplies.

onUrlSubmitted

Le propriétaire du compte a indiqué la page à vérifier depuis l’assistant — saisie à la main ou choisie parmi les pages suggérées. Accessible uniquement lorsqu’aucune destination n’a été fournie au montage.
object

onVerifyLaunched

« Verify live » a été pressé. popupBlocked signifie que le navigateur a refusé la fenêtre du funnel, de sorte que le parcours n’a jamais commencé.
object

onVerifyConnected

La page du funnel a renvoyé un signal à l’assistant — le pixel y est chargé et le parcours est en cours.
object

onVerdict

Le parcours de vérification en direct est terminé. ok signifie qu’il n’y a aucune lacune de tracking ; sinon, gaps contient les codes des lacunes détectées par le parcours.
object

onEventVerified

Le propriétaire du compte a parcouru son funnel avec « Verify live » et cet événement s’est déclenché — la preuve qu’il est configuré là où une analyse côté serveur ne peut pas accéder.
object

onLoaderStart

S’exécute après le premier affichage du squelette de chargement et avant onReady.

onReady

S’exécute après le premier affichage complet de l’élément.

onError

S’exécute lorsque l’élément ne parvient pas à se charger ou plante. L’affichage de repli reste visible. Utilisez code pour une gestion programmatique. sourceKey identifie une source d’état hôte en échec.
object

Méthodes

Appelez-les sur le handle renvoyé par create, ou via une ref React.

mount

Monte l’élément dans target et démarre le chargement. Les composants React se montent eux-mêmes. Paramètres
string | HTMLElement
requis

destroy

Supprime l’élément et libère son frame et ses abonnements. Vous pouvez l’appeler plusieurs fois. React supprime l’élément automatiquement.

update

Fusionne de nouvelles props dans l’élément monté. Avec React, modifiez plutôt les props du composant. Paramètres
Partial<PixelSetupElementProps>
requis

Style

Stylisez ces parties via appearance.classes. Utilisez le camel case ou le kebab case pour les noms de propriétés et incluez les unités. Les feuilles de style de la page ne peuvent pas atteindre le frame de l’élément. Le framework valide chaque déclaration avant de l’injecter.
Avec React, transmettez appearance à <Websites>. Définissez-la globalement avec WhopElements({ appearance }).