Skip to main content
Un membre est inscrit lorsque le trigger_event de l’automatisation se produit pour lui, comme payment.succeeded. Vous pouvez aussi inscrire un membre avec POST /automations/{id}/trigger. Une étape wait le met en attente pendant une durée définie. Une étape email ou message exécute son source_code, un module TSX qui lit les données du membre via l’API. Le module décide s’il faut envoyer et quoi dire. Les étapes sont versionnées. Vous modifiez la version brouillon. POST /automations/{id}/publish en fait la version sur laquelle démarrent les nouveaux membres, puis la copie dans le brouillon suivant. Chaque publication fait passer les membres déjà présents dans l’automatisation à la nouvelle version. Utilisez l’API Automations pour créer, publier et déclencher des automatisations, et pour les mettre à jour, y compris leur statut. Utilisez les API Automation steps et Automation enrollments pour leurs étapes et leurs membres.

Endpoints

Attributs

string
requis
ID de l’automatisation, préfixé par ato_.
string
requis
ID du compte auquel appartient l’automatisation, préfixé par biz_.
integer
requis
Membres actuellement dans l’automatisation.
string
requis
Date de création de l’automatisation, sous forme d’horodatage ISO 8601.
object
requis
Qui a créé l’automatisation.

Propriétés

string
requis
ID de l’utilisateur, du compte ou de l’app, préfixé par user_, biz_ ou app_.
string
requis
Ce qui a agi : un user, un account via l’une de ses clés API, ou une app.Options disponibles : user, account, app
integer
requis
La version modifiée par les modifications d’étapes. Toujours égale à published_version plus un, ou 1 avant la première publication.
boolean
requis
Indique si le brouillon comporte des modifications que POST /automations/\{id}/publish publierait. Toujours true avant la première publication.
string
requis
Le nom de l’automatisation, affiché dans le tableau de bord. Jusqu’à 255 caractères.
string | null
requis
Date de dernière publication de l’automatisation, sous forme d’horodatage ISO 8601. null jusqu’à sa première publication.
object | null
requis
Qui a publié l’automatisation en dernier. null jusqu’à sa première publication.

Propriétés

string
requis
ID de l’utilisateur, du compte ou de l’app, préfixé par user_, biz_ ou app_.
string
requis
Ce qui a agi : un user, un account via l’une de ses clés API, ou une app.Options disponibles : user, account, app
integer | null
requis
La version sur laquelle démarrent les nouveaux membres. null jusqu’à la première publication de l’automatisation.
string[]
requis
Noms des secrets de l’automatisation, que le code de ses étapes lit comme variables d’environnement. Leurs valeurs ne sont jamais renvoyées.
string
requis
active inscrit les membres et exécute leurs étapes. closed n’inscrit plus personne, et les membres déjà présents terminent. stopped n’inscrit personne, et les inscriptions de ses membres sont terminées. Une nouvelle automatisation est stopped jusqu’à ce que sa première publication la rende active.Options disponibles : active, closed, stopped
integer
requis
Nombre de fois où des membres se sont inscrits à l’automatisation, y compris les inscriptions terminées.
string | null
requis
L’événement webhook qui inscrit le membre concerné, comme payment.succeeded. null pour une automatisation dans laquelle seul POST /automations/\{id}/trigger inscrit. Fixé une fois l’automatisation publiée.Options disponibles : payment.succeeded, payment.failed, membership.activated, membership.trial_ending_soon, member.created, invoice.created, invoice.paid, invoice.past_due, refund.created, dispute.created, resolution_center_case.created, resolution_center_case.decided, course_lesson_interaction.completed
string
requis
Date de dernière mise à jour de l’automatisation, sous forme d’horodatage ISO 8601.
Automation