Skip to main content
Un miembro se inscribe cuando le ocurre el trigger_event de la automatización, como payment.succeeded. También puedes inscribir a un miembro con POST /automations/{id}/trigger. Un paso wait lo retiene durante un tiempo determinado. Un paso email o message ejecuta su source_code, un módulo TSX que lee los datos del miembro a través de la API. El módulo decide si envía algo y qué dice. Los pasos tienen versiones. Tú editas la versión en borrador. POST /automations/{id}/publish la convierte en la versión en la que empiezan los miembros nuevos y luego la copia en el siguiente borrador. Cada publicación mueve a los miembros que ya están en la automatización a la nueva versión. Usa la API de Automations para crear, publicar y activar automatizaciones, y para actualizarlas, incluido su estado. Usa las APIs de Automation steps y Automation enrollments para sus pasos y miembros.

Endpoints

Atributos

string
requerido
ID de la automatización, con el prefijo ato_.
string
requerido
ID de la cuenta a la que pertenece la automatización, con el prefijo biz_.
integer
requerido
Miembros que están actualmente en la automatización.
string
requerido
Cuándo se creó la automatización, como marca de tiempo ISO 8601.
object
requerido
Quién creó la automatización.

Propiedades

string
requerido
ID del usuario, la cuenta o la app, con el prefijo user_, biz_ o app_.
string
requerido
Quién actuó: un user, una account mediante una de sus API keys, o una app.Opciones disponibles: user, account, app
integer
requerido
La versión que modifican las ediciones de pasos. Siempre published_version más uno, o 1 antes de la primera publicación.
boolean
requerido
Si el borrador tiene ediciones que POST /automations/\{id}/publish publicaría. Siempre true antes de la primera publicación.
string
requerido
El nombre de la automatización, que se muestra en el panel. Hasta 255 caracteres.
string | null
requerido
Cuándo se publicó la automatización por última vez, como marca de tiempo ISO 8601. null hasta su primera publicación.
object | null
requerido
Quién publicó la automatización por última vez. null hasta su primera publicación.

Propiedades

string
requerido
ID del usuario, la cuenta o la app, con el prefijo user_, biz_ o app_.
string
requerido
Quién actuó: un user, una account mediante una de sus API keys, o una app.Opciones disponibles: user, account, app
integer | null
requerido
La versión en la que empiezan los miembros nuevos. null hasta que la automatización se publica por primera vez.
string[]
requerido
Nombres de los secretos de la automatización, que el código de sus pasos lee como variables de entorno. Sus valores nunca se devuelven.
string
requerido
active inscribe miembros y ejecuta sus pasos. closed no inscribe a nadie nuevo, y los miembros que ya están en ella terminan. stopped no inscribe a nadie, y las inscripciones de sus miembros han terminado. Una automatización nueva está en stopped hasta que su primera publicación la pone en active.Opciones disponibles: active, closed, stopped
integer
requerido
Cuántas veces se han inscrito miembros en la automatización, incluidas las inscripciones que han terminado.
string | null
requerido
El evento de webhook que inscribe al miembro al que se refiere, como payment.succeeded. null para una automatización en la que solo inscribe POST /automations/\{id}/trigger. Queda fijo una vez publicada la automatización.Opciones 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
requerido
Cuándo se actualizó la automatización por última vez, como marca de tiempo ISO 8601.
Automation