CLI
Automatizaciones y eventos
Cada comando de las automatizaciones, las personas que están dentro y los eventos que las hacen avanzar, con ejemplos prácticos.
Cómo encaja todo
Una automatización es un desencadenante y un árbol de pasos. Guarda un borrador y una versión activa: update cambia el borrador y los ajustes, y publish congela el borrador y activa la automatización. Leer requiere automations:read y cambiar requiere automations:write. publish, resume y send-test también requieren emails:send, porque hacen que la automatización envíe correo.
openemail automations create --name "Welcome series" --starter welcome-seriesopenemail automations update aut_5c1e9a7b3d2f48e6a0b4c7d1 --data @welcome.jsonopenemail automations publish aut_5c1e9a7b3d2f48e6a0b4c7d1openemail automations stats aut_5c1e9a7b3d2f48e6a0b4c7d1La definición es JSON, así que escríbela en un archivo y pásala con --data @file. openemail automations get <id> --json imprime la actual, y su problems lista lo que todavía impide publicarla.
Automatizaciones
| Comando | Qué hace |
|---|---|
| openemail automations list | Una página de las automatizaciones, primero las modificadas más recientemente. --status la limita a draft, live, paused o archived |
| openemail automations create --name <value> | Crear un borrador a partir de --starter, de una definición en --data o uno vacío |
| openemail automations get <id> | Una automatización con su borrador, su versión activa, sus ajustes y lo que falla en el borrador |
| openemail automations update <id> | Cambiar el nombre, los ajustes o la definición del borrador. --expected-updated-at se niega a sobrescribir un cambio hecho desde que lo leíste |
| openemail automations publish <id> | Congelar el borrador como la siguiente versión y activar la automatización |
| openemail automations pause <id> | Detener una automatización activa. Todos los que están dentro se quedan donde están |
| openemail automations resume <id> | Volver a activar una automatización en pausa con la versión que tenía en marcha |
| openemail automations archive <id> | Retirar una automatización para siempre y conservar su historial. Todos los que están dentro salen |
| openemail automations duplicate <id> | Copiar una automatización en un borrador nuevo, sin sus personas ni sus cifras |
| openemail automations delete <id> | Eliminar una automatización y su historial después de que confirmes. Un inicio de sesión con el navegador también pide un código de verificación |
| openemail automations list-starters | Los puntos de partida desde los que puede empezar una automatización nueva |
Pruebas, versiones y cifras
| Comando | Qué hace |
|---|---|
| openemail automations send-test <id> --step-key <value> | Enviarte a ti, o a --to, un paso de correo del borrador con valores de ejemplo. No inscribe a nadie |
| openemail automations list-versions <id> | Todas las versiones publicadas, las más recientes primero |
| openemail automations restore-version <id> <version> | Copiar una versión anterior de vuelta al borrador. Publica para que se ejecute |
| openemail automations stats <id> | Totales, una fila por cada paso y un punto por cada día. --since fija dónde empieza el periodo, que por defecto son los últimos 30 días |
Las personas dentro de una automatización
| Comando | Qué hace |
|---|---|
| openemail automations list-enrollments <id> | Las personas que entraron, las más recientes primero, con el paso en el que está cada una. --status y --step-key lo limitan, y --all lee todas las páginas |
| openemail automations get-enrollment <id> <enrollment-id> | El recorrido de una persona, con cada paso que se ejecutó y el correo que produjo cada envío |
| openemail automations enroll <id> --email <value> | Meter a un contacto en una automatización activa por su primer paso. --contact-id indica el contacto por id en su lugar |
| openemail automations exit-enrollment <id> <enrollment-id> | Sacar a alguien antes de que termine |
openemail automations list-enrollments aut_5c1e9a7b3d2f48e6a0b4c7d1 --status active --all --json | jq -r '.items[] | .contact.email + " " + (.stepKey // "")'Eventos
Un evento dice que un contacto hizo algo en tu producto. Inicia cada automatización activa cuyo desencadenante lo nombra y hace avanzar a quien lo estuviera esperando. Enviar uno requiere contacts:write.
| Comando | Qué hace |
|---|---|
| openemail events send --name <value> --email <value> | Registrar un evento de un contacto. --create-contact añade el contacto cuando nadie tiene aún la dirección, y --idempotency-key hace que un reintento sea seguro |
| openemail events send-batch <events> | Registrar hasta 100 eventos desde un archivo JSON e imprimir cuáles se aceptaron y cuáles se rechazaron |
| openemail events list-names | Los nombres de evento que ha enviado el espacio de trabajo, para elegir uno en un desencadenante |
| openemail contacts list-events <email> | Los eventos que hizo un contacto, los más recientes primero. --name lo limita a un solo evento |
openemail events send --data '{"name":"order.placed","email":"[email protected]","properties":{"orderId":"AC-4192"}}' --idempotency-key order:AC-4192:placedopenemail events send-batch @events.jsonopenemail contacts list-events [email protected] --name order.placedLas propiedades van en el cuerpo JSON, así que envía con --data un evento que las tenga. Los eventos se conservan 90 días.