Skip to main content
Une étape email ou message exécute son source_code pour décider s’il faut envoyer et quoi dire. Les étapes forment une chaîne, et chaque étape désigne l’étape qui la précède. Seule la version brouillon peut être modifiée. Utilisez l’API Automation steps pour lister les étapes d’une version, et pour ajouter, mettre à jour et supprimer des étapes dans le brouillon. Vous pouvez aussi prévisualiser ce qu’une étape email ou message enverrait à un membre. Une prévisualisation n’envoie rien. Le code d’une étape lit le compte via l’API. Il dispose de toutes les autorisations :read au niveau du compte que possèdent à la fois le rôle admin et Whop AI, à l’exception de payout:account:read. Il ne peut donc pas lire les cartes. Définir le source_code d’une étape, ou prévisualiser une étape, nécessite chacune de ces autorisations. Ainsi, un identifiant ne peut pas écrire de code qui lit plus que ce qu’il peut lire lui-même.

Endpoints

Attributs

string
requis
ID de l’étape d’automatisation, préfixé par atos_. Une étape reçoit un nouvel ID dans chaque version. Sa key reste la même.
string
requis
Ce que fait l’étape : wait met le membre en attente pendant config.delay_seconds, email lui envoie un e-mail, et message lui envoie un message de la part d’un membre de l’équipe. Une étape brouillon peut basculer entre email et message, ce qui efface config.sender_id. Une étape wait ne peut pas devenir une étape d’envoi, ni l’inverse.Options disponibles : wait, email, message
string
requis
ID de l’automatisation à laquelle appartient l’étape, préfixé par ato_.
object
requis
Les paramètres de l’étape pour son action_type : delay_seconds pour un wait, sender_id pour un email ou un message. L’écrire remplace l’objet entier.
string
requis
Date de création de l’étape, sous forme d’horodatage ISO 8601.
string[]
requis
Ce qui doit être corrigé avant que le brouillon puisse être publié, comme du code qui n’a pas encore été écrit. Vide lorsqu’il n’y a rien.
integer
requis
Identifie la même étape d’une version à l’autre. Une nouvelle étape reçoit une clé qu’aucune étape de l’automatisation n’a utilisée.
string | null
requis
ID de l’étape après laquelle celle-ci s’exécute, préfixé par atos_. null lorsqu’elle s’exécute en premier, directement après l’inscription du membre.
email_address or user | null
requis
L’expéditeur désigné par config.sender_id. null sur un wait, et lorsque l’étape envoie depuis l’expéditeur par défaut.
string | null
requis
Le code d’une étape email ou message : un module TSX dont l’export par défaut reçoit le membre et renvoie message.send(), message.skip() ou message.exit() depuis whop:message. Une étape email envoie son subject, son élément react comme corps et son text comme partie en texte brut. Une étape message envoie son text. Le code peut importer react et @react-email/components. Il lit le compte via le client whop de whop:message, qui ne peut que lire. Ce client dispose de toutes les autorisations :read au niveau du compte que possèdent à la fois le rôle admin et Whop AI, à l’exception de payout:account:read, comme indiqué pour la prévisualisation d’une étape. Le définir, ou prévisualiser l’étape, nécessite chacune de ces autorisations. Jusqu’à 64 000 caractères. null sur un wait, et tant qu’il n’est pas écrit.
string
requis
Date de dernière mise à jour de l’étape, sous forme d’horodatage ISO 8601.
integer
requis
La version de l’automatisation dont fait partie cette étape. Seules les étapes de la version brouillon peuvent être modifiées.
integer
requis
Membres de la version de cette étape qui attendent son exécution.
AutomationStep