Skip to main content
Et medlem tilmeldes, når automatiseringens trigger_event sker for dem, såsom payment.succeeded. Du kan også tilmelde et medlem med POST /automations/{id}/trigger. Et wait-trin holder dem i et fastsat tidsrum. Et email- eller message-trin kører sin source_code, et TSX-modul, der læser medlemmets data gennem API’et. Modulet afgør, om der skal sendes, og hvad der skal stå. Trin er versionerede. Du redigerer kladdeversionen. POST /automations/{id}/publish gør den til den version, nye medlemmer starter på, og kopierer den derefter til den næste kladde. Hver udgivelse flytter medlemmer, der allerede er i automatiseringen, over på den nye version. Brug Automations API’et til at oprette, udgive og udløse automatiseringer og til at opdatere dem, herunder deres status. Brug Automation steps- og Automation enrollments-API’erne til deres trin og medlemmer.

Endpoints

Attributter

string
påkrævet
Automation-ID med præfikset ato_.
string
påkrævet
ID for den konto, automatiseringen tilhører, med præfikset biz_.
integer
påkrævet
Medlemmer, der i øjeblikket er i automatiseringen.
string
påkrævet
Hvornår automatiseringen blev oprettet, som et ISO 8601-tidsstempel.
object
påkrævet
Hvem der oprettede automatiseringen.

Egenskaber

string
påkrævet
ID for brugeren, kontoen eller appen med præfikset user_, biz_ eller app_.
string
påkrævet
Hvad der handlede: en user, en account via en af dens API-nøgler eller en app.Tilgængelige muligheder: user, account, app
integer
påkrævet
Den version, som trinredigeringer ændrer. Altid published_version plus én, eller 1 før den første udgivelse.
boolean
påkrævet
Om kladden har redigeringer, som POST /automations/\{id}/publish ville udgive. Altid true før den første udgivelse.
string
påkrævet
Automatiseringens navn, som vises på dashboardet. Op til 255 tegn.
string | null
påkrævet
Hvornår automatiseringen sidst blev udgivet, som et ISO 8601-tidsstempel. null indtil dens første udgivelse.
object | null
påkrævet
Hvem der sidst udgav automatiseringen. null indtil dens første udgivelse.

Egenskaber

string
påkrævet
ID for brugeren, kontoen eller appen med præfikset user_, biz_ eller app_.
string
påkrævet
Hvad der handlede: en user, en account via en af dens API-nøgler eller en app.Tilgængelige muligheder: user, account, app
integer | null
påkrævet
Den version, nye medlemmer starter på. null, indtil automatiseringen udgives første gang.
string[]
påkrævet
Navne på automatiseringens hemmeligheder, som dens trins kode læser som miljø- variabler. Deres værdier returneres aldrig.
string
påkrævet
active tilmelder medlemmer og kører deres trin. closed tilmelder ingen nye, og medlemmer, der allerede er i den, gør forløbet færdigt. stopped tilmelder ingen, og dens medlemmers tilmeldinger er afsluttet. En ny automatisering er stopped, indtil dens første udgivelse gør den active.Tilgængelige muligheder: active, closed, stopped
integer
påkrævet
Hvor mange gange medlemmer er blevet tilmeldt automatiseringen, inklusive tilmeldinger, der er afsluttet.
string | null
påkrævet
Den webhook-hændelse, der tilmelder det medlem, den handler om, såsom payment.succeeded. null for en automatisering, som kun POST /automations/\{id}/trigger tilmelder til. Fastlåst, når automatiseringen er blevet udgivet.Tilgængelige muligheder: 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
påkrævet
Hvornår automatiseringen sidst blev opdateret, som et ISO 8601-tidsstempel.
Automation