Skip to main content
Een lid wordt ingeschreven wanneer het trigger_event van de automation voor dat lid plaatsvindt, zoals payment.succeeded. Je kunt een lid ook inschrijven met POST /automations/{id}/trigger. Een wait-stap houdt het lid een ingestelde tijd vast. Een email- of message-stap voert zijn source_code uit, een TSX-module die de gegevens van het lid via de API leest. De module bepaalt of er iets wordt verstuurd en wat. Stappen hebben versies. Je bewerkt de conceptversie. POST /automations/{id}/publish maakt daarvan de versie waarop nieuwe leden starten en kopieert deze vervolgens naar het volgende concept. Elke publicatie verplaatst leden die al in de automation zitten naar de nieuwe versie. Gebruik de Automations API om automations aan te maken, te publiceren en te triggeren, en om ze bij te werken, inclusief hun status. Gebruik de Automation steps- en Automation enrollments-API’s voor hun stappen en leden.

Endpoints

Attributen

string
vereist
Automation-ID, met prefix ato_.
string
vereist
ID van het account waartoe de automation behoort, met prefix biz_.
integer
vereist
Leden die momenteel in de automation zitten.
string
vereist
Wanneer de automation is aangemaakt, als ISO 8601-tijdstempel.
object
vereist
Wie de automation heeft aangemaakt.

Eigenschappen

string
vereist
ID van de gebruiker, het account of de app, met prefix user_, biz_ of app_.
string
vereist
Wat de handeling uitvoerde: een user, een account via een van zijn API-sleutels, of een app.Beschikbare opties: user, account, app
integer
vereist
De versie die door stapbewerkingen wordt gewijzigd. Altijd published_version plus één, of 1 vóór de eerste publicatie.
boolean
vereist
Of het concept bewerkingen bevat die POST /automations/\{id}/publish zou publiceren. Altijd true vóór de eerste publicatie.
string
vereist
De naam van de automation, weergegeven in het dashboard. Maximaal 255 tekens.
string | null
vereist
Wanneer de automation voor het laatst is gepubliceerd, als ISO 8601-tijdstempel. null tot de eerste publicatie.
object | null
vereist
Wie de automation voor het laatst heeft gepubliceerd. null tot de eerste publicatie.

Eigenschappen

string
vereist
ID van de gebruiker, het account of de app, met prefix user_, biz_ of app_.
string
vereist
Wat de handeling uitvoerde: een user, een account via een van zijn API-sleutels, of een app.Beschikbare opties: user, account, app
integer | null
vereist
De versie waarop nieuwe leden starten. null totdat de automation voor het eerst is gepubliceerd.
string[]
vereist
Namen van de secrets van de automation, die de code van de stappen als omgevingsvariabelen leest. Hun waarden worden nooit geretourneerd.
string
vereist
active schrijft leden in en voert hun stappen uit. closed schrijft niemand nieuw in, en leden die er al in zitten maken het af. stopped schrijft niemand in, en de enrollments van de leden zijn beëindigd. Een nieuwe automation is stopped totdat de eerste publicatie deze active maakt.Beschikbare opties: active, closed, stopped
integer
vereist
Hoe vaak leden zich in de automation hebben ingeschreven, inclusief beëindigde enrollments.
string | null
vereist
Het webhook-event dat het lid inschrijft waarover het gaat, zoals payment.succeeded. null voor een automation waarin alleen POST /automations/\{id}/trigger inschrijft. Vastgelegd zodra de automation is gepubliceerd.Beschikbare opties: 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
vereist
Wanneer de automation voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.
Automation