Skip to main content
POST
Add a schedule

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Path Parameters

agent_id
string
required

The agent’s id.

Body

application/json
procedure_id
string
required
cron
string
required
name
string

Defaults to the procedure’s title.

Maximum string length: 100
time_zone
string
default:UTC
inputs
object

Must give every required input of the procedure: nobody is there to ask.

notify
object

Who hears when a run ends. The org’s webhook always gets schedule.run_completed or schedule.run_failed.

status
enum<string>
Available options:
active,
paused

Response

The schedule.

An agent’s procedure, run on a cron expression in a time zone.

object
any
required
id
string
required
Example:

"sch_8c1e2f3a4b5c6d7e8f"

agent_id
string
required
procedure_id
string
required
name
string
required
Example:

"Morning warranty check"

cron
string
required

Minute, hour, day of the month, month, day of the week. *, ranges, steps, lists and names (MON, JAN); @hourly, @daily, @weekly, @monthly, @yearly.

Example:

"0 9 * * 1-5"

time_zone
string
required
Example:

"America/New_York"

description
string
required
Example:

"Every weekday at 09:00"

inputs
object
required

The procedure’s inputs (and any other values), as the run’s conversation variables.

notify
object
required

Who hears when a run ends. The org’s webhook always gets schedule.run_completed or schedule.run_failed.

status
enum<string>
required
Available options:
active,
paused
procedure
object | null
next_run_at
string<date-time> | null

Null while paused.

last_run
object | null

One run of a schedule, or a slot it skipped or missed.

created_by
Person · object

Who did it: a person (in the console) or an API key. Null when nobody was recorded: it was made with a session token, by Eager itself, or before this was kept.

created_at
string<date-time>
updated_at
string<date-time>