Referencia de la API

Programaciones

Crea, previsualiza, pausa y ejecuta programaciones.

Inicia un flujo de trabajo guardado según una programación. Cualquier clave puede listar y leer programaciones e iniciar una al instante; crearlas, modificarlas y eliminarlas requiere un propietario o administrador. Consulta programaciones para saber cómo funcionan los inicios.

Crear una programación

POST/v1/schedules
Comprueba que el flujo de trabajo se resuelva en una ejecución que se admitiría ahora y después guarda la programación. Responde 201 con la programación.
Cuerpo
workflowstringobligatorio
Nombre del flujo de trabajo guardado que se iniciará.
cronstringobligatorio
Expresión cron de cinco campos, o una abreviatura como @daily o @every 90m. Como máximo una vez por minuto.
timezonestring
Zona horaria IANA en la que se interpreta la programación, como Europe/Madrid. Por defecto UTC.
namestring
Una etiqueta para las personas. Hasta 128 caracteres.
inputany JSON
Entrada de cada ejecución. Hasta 1 MiB.
max_cost_microsinteger
Presupuesto de cada ejecución. Si se omite, el presupuesto predeterminado.
skip_if_runningboolean
Omite un inicio mientras la ejecución anterior sigue en marcha. Por defecto true.
enabledboolean
Por defecto true.
curl -X POST $EPHEMERAL_URL/v1/schedules \
  -H "Authorization: Bearer $EPHEMERAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow": "welcome-new-customers",
    "name": "Weekday welcome emails",
    "cron": "0 9 * * 1-5",
    "timezone": "Asia/Tokyo",
    "input": { "signed_up": "yesterday" },
    "max_cost_micros": 200000
  }'
Campos de la programación que establece Ephemeral
next_run_atstring | null
El siguiente inicio, en UTC. null mientras la programación está desactivada.
last_run_atstring
Cuándo le tocó ejecutarse por última vez a la programación.
last_run_idstring
La última ejecución que inició.
last_errorstring
Por qué se omitió o falló el último inicio, o por qué se pausó la programación. Vacío después de un inicio correcto.
failuresinteger
Inicios fallidos seguidos. Al llegar a 5, la programación se desactiva sola.

Previsualizar una programación

POST/v1/schedules/preview
Comprueba cron y timezone y devuelve las cinco próximas horas de inicio, sin guardar nada. Una programación no válida devuelve 400 con el motivo.
JSON
{ "next": ["2026-10-05T00:00:00Z", "2026-10-06T00:00:00Z", "2026-10-07T00:00:00Z", "2026-10-08T00:00:00Z", "2026-10-09T00:00:00Z"] }

Listar programaciones

GET/v1/schedules
Devuelve {"items": [...]}, de la más antigua a la más reciente. Añade ?workflow= para listar las programaciones de un flujo de trabajo.

Obtener una programación

GET/v1/schedules/{id}

Actualizar una programación

PATCH/v1/schedules/{id}
Envía cualquiera de los campos de creación; el resto se queda como está. Un nuevo cron o timezone calcula el siguiente inicio a partir de ahora. Poner enabled en true en una programación pausada borra sus fallos.

Iniciar ahora

POST/v1/schedules/{id}/run
Inicia el flujo de trabajo ahora con la entrada y el presupuesto de la programación, fuera de su calendario. Responde 202 con la ejecución, que lleva el ID de la programación.

Eliminar una programación

DELETE/v1/schedules/{id}
Responde 204. Las ejecuciones que inició conservan su registro.

Ejecuciones de una programación

GET /v1/runs?schedule={id} lista las ejecuciones que inició una programación, de la más reciente a la más antigua, con la misma paginación que listar ejecuciones.

Una organización puede tener hasta 50 programaciones.
© 2026 EphemeralProducido por erni.works
esc

Nada coincide con “”.