Skip to main content
payment.succeeded처럼 자동화의 trigger_event가 멤버에게 발생하면 멤버가 등록됩니다. POST /automations/{id}/trigger로 멤버를 등록할 수도 있습니다. wait 단계는 정해진 시간 동안 멤버를 대기시킵니다. email 또는 message 단계는 API를 통해 멤버의 데이터를 읽는 TSX 모듈인 source_code를 실행합니다. 이 모듈이 전송 여부와 보낼 내용을 결정합니다. 단계는 버전으로 관리됩니다. 편집은 초안 버전에서 합니다. POST /automations/{id}/publish는 초안을 새 멤버가 시작하는 버전으로 만든 다음, 이를 다음 초안으로 복사합니다. 게시할 때마다 이미 자동화에 있는 멤버는 새 버전으로 이동합니다. Automations API를 사용해 자동화를 생성, 게시, 트리거하고 상태를 포함해 업데이트하세요. 단계와 멤버에는 Automation steps API와 Automation enrollments API를 사용하세요.

엔드포인트

속성

string
필수
ato_ 접두사가 붙은 자동화 ID입니다.
string
필수
자동화가 속한 계정의 ID이며, biz_ 접두사가 붙습니다.
integer
필수
현재 자동화에 있는 멤버 수입니다.
string
필수
자동화가 생성된 시각(ISO 8601 타임스탬프)입니다.
object
필수
자동화를 생성한 주체입니다.

속성

string
필수
사용자, 계정 또는 앱의 ID이며, user_, biz_ 또는 app_ 접두사가 붙습니다.
string
필수
작업 주체입니다. user, API 키를 통한 account 또는 app 중 하나입니다.사용 가능한 옵션: user, account, app
integer
필수
단계 편집이 변경하는 버전입니다. 항상 published_version에 1을 더한 값이며, 첫 게시 전에는 1입니다.
boolean
필수
초안에 POST /automations/\{id}/publish로 게시될 편집 내용이 있는지 여부입니다. 첫 게시 전에는 항상 true입니다.
string
필수
대시보드에 표시되는 자동화 이름입니다. 최대 255자입니다.
string | null
필수
자동화가 마지막으로 게시된 시각(ISO 8601 타임스탬프)입니다. 첫 게시 전까지는 null입니다.
object | null
필수
자동화를 마지막으로 게시한 주체입니다. 첫 게시 전까지는 null입니다.

속성

string
필수
사용자, 계정 또는 앱의 ID이며, user_, biz_ 또는 app_ 접두사가 붙습니다.
string
필수
작업 주체입니다. user, API 키를 통한 account 또는 app 중 하나입니다.사용 가능한 옵션: user, account, app
integer | null
필수
새 멤버가 시작하는 버전입니다. 자동화가 처음 게시될 때까지 null입니다.
string[]
필수
단계 코드가 환경 변수로 읽는 자동화 시크릿의 이름입니다. 값은 절대 반환되지 않습니다.
string
필수
active는 멤버를 등록하고 단계를 실행합니다. closed는 새 멤버를 등록하지 않으며, 이미 있는 멤버는 끝까지 진행합니다. stopped는 아무도 등록하지 않으며, 멤버의 등록은 종료된 상태입니다. 새 자동화는 첫 게시로 active가 될 때까지 stopped 상태입니다.사용 가능한 옵션: active, closed, stopped
integer
필수
종료된 등록을 포함해 멤버가 자동화에 등록된 총 횟수입니다.
string | null
필수
payment.succeeded처럼 이벤트 대상 멤버를 등록시키는 웹훅 이벤트입니다. POST /automations/\{id}/trigger로만 등록되는 자동화에서는 null입니다. 자동화가 게시된 후에는 고정됩니다.사용 가능한 옵션: 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
필수
자동화가 마지막으로 업데이트된 시각(ISO 8601 타임스탬프)입니다.
Automation