Skip to main content
GET
Retrieve Automation Step

인증

Authorization
string
header
필수

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

automation:read

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

경로 매개변수

id
string
필수

Automation step ID, prefixed atos_.

응답

Automation step details

action_type
enum<string>
필수

What the step does: wait holds the member for config.delay_seconds, email emails them, and message sends them a message from a team member. A draft step can switch between email and message, which clears config.sender_id. A wait can't become a sending step, or the other way round.

사용 가능한 옵션:
wait,
email,
message
예시:

"email"

automation_id
string
필수

ID of the automation the step belongs to, prefixed ato_.

예시:

"ato_xxxxxxxxxxxxxx"

config
Wait · object
필수

The step's settings for its action_type: delay_seconds for a wait, sender_id for an email or message. Writing it replaces the whole object.

created_at
string
필수

When the step was created, as an ISO 8601 timestamp.

예시:

"2026-01-01T12:00:00.000Z"

id
string
필수

Automation step ID, prefixed atos_. A step gets a new ID in every version. Its key stays the same.

예시:

"atos_xxxxxxxxxxxxxx"

issues
string[]
필수

What must be fixed before the draft can be published, such as code that hasn't been written. Empty when there's nothing.

key
integer
필수

Identifies the same step across versions. A new step gets a key no step of the automation has used.

예시:

2

previous_step_id
string | null
필수

ID of the step this one runs after, prefixed atos_. null when it runs first, directly after the member enrolls.

예시:

"atos_xxxxxxxxxxxxxx"

sender
Email address · object
필수

The sender config.sender_id names. null on a wait, and when the step sends from the default sender.

source_code
string | null
필수

An email or message step's code: a TSX module whose default export gets the member and returns message.send(), message.skip() or message.exit() from whop:message. An email step sends its subject, its react element as the body and its text as the plain-text part. A message step sends its text. The code can import react and @react-email/components. It reads the account through the whop client from whop:message, which can only read. That client holds every account-level :read permission that both the admin role and Whop AI hold, except payout:account:read, as listed for previewing a step. Setting it, or previewing the step, needs every one of those permissions. Up to 64,000 characters. null on a wait, and until it is written.

예시:

"export default () => message.send({ subject: \"Thanks!\", text: \"Thanks for your order!\" });"

updated_at
string
필수

When the step was last updated, as an ISO 8601 timestamp.

예시:

"2026-01-01T12:00:00.000Z"

version
integer
필수

The automation version this step is part of. Only the draft version's steps can change.

예시:

1

waiting_enrollments_count
integer
필수

Members on this step's version who are waiting for it to run.

예시:

0