ElectroNeek Documentation

Create Schedule

This creates a schedule for a Workflow. Requires permission to edit schedules.

posthttps://api.{region}.electroneek.com/v1/orchestrator/schedule

{region} may be: na, cis, apac, latam, emea

Try it

Sent from your browser straight to the API — nothing passes through this site, and the api token is kept in this tab only.
cURL
curl --request POST \
  --url 'https://api.na.electroneek.com/v1/orchestrator/schedule' \
  --header 'Content-Type: application/json' \
  --data '{"workflow_id": "","type": "direct","timezoneLocation": "","params": {"directDateTime": "2099-10-07T09:30:00","period": "hourly","hours": 0,"minutes": 0,"seconds": 0,"dayOfWeek": [0],"dayNumber": [""],"restriction": {"excludeDays": {"isEnabled": false,"value": [0]},"rangeStart": {"isEnabled": false,"value": {"hours": 0,"minutes": 0}},"rangeEnd": {"isEnabled": false,"value": {"hours": 0,"minutes": 0}}}},"isActive": false,"botRunner": {"robotId": "","busyPolicy": "queue","offlinePolicy": "fallback","displayName": ""}}'

Authentication

Use an API Token from the Orchestrator → Integrations page. Send it as a bearer token: Authorization: Bearer <token>.

Request body

NameTypeRequiredDescription
workflow_idstringyesID of the workflow the schedule launches
typestring (direct, repeatable)yes`direct` runs once, `repeatable` runs on a recurring period
timezoneLocationstringyesIANA time zone, such as `America/Sao_Paulo`
paramsobjectyesWhen the schedule runs. For a `direct` (one-time) schedule, send only `directDateTime`. For a `repeatable` schedule, send `period` and the fields that period uses: * `hourly`: `minutes`, optional `restriction` * `daily`: `hours`, `minutes`, optional `restriction` * `weekly`: `dayOfWeek`, `hours`, `minutes` * `monthly`: `dayNumber`, `hours`, `minutes` * `custom`: `hours` (0 to 1000), `minutes`, `seconds`, optional `restriction`. Repeats at this interval, counted from when the schedule was created.
isActivebooleannoWhether the schedule is enabled
botRunnerobject · nullablenoThe Bot Runner that runs this schedule. `null` uses the workflow's Bot Runner selection.

Response

201Created
Response body
object
idstring

Schedule ID

workflow_idstring

ID of the workflow the schedule launches

typestring (direct, repeatable)

direct runs once, repeatable runs on a recurring period

timezoneLocationstring

IANA time zone, such as America/Sao_Paulo

paramsobject

When the schedule runs. For a direct (one-time) schedule, send only directDateTime. For a repeatable schedule, send period and the fields that period uses:

  • hourly: minutes, optional restriction
  • daily: hours, minutes, optional restriction
  • weekly: dayOfWeek, hours, minutes
  • monthly: dayNumber, hours, minutes
  • custom: hours (0 to 1000), minutes, seconds, optional restriction. Repeats at this interval, counted from when the schedule was created.
object
directDateTimestring

One-time schedules only. Local date and time in timezoneLocation, formatted YYYY-MM-DDTHH:mm:ss, without a UTC offset or Z.

periodstring (hourly, daily, weekly, monthly, custom)

Repeatable schedules only.

hoursinteger

0 to 23 (0 to 1000 for custom).

minutesinteger
secondsinteger

custom only.

dayOfWeekarray of integer

weekly only. One-element array, 0 = Sunday to 6 = Saturday.

integer
dayNumberarray of string

monthly only. One-element array with "1" to "31" or "last".

string
restrictionobject

Optional limits for hourly, daily and custom schedules. Disabled restrictions are ignored.

object
excludeDaysobject

Weekdays when the schedule doesn't run (0 = Sunday to 6 = Saturday). Excluding all seven days is rejected. Hourly, daily and custom schedules.

object
isEnabledboolean
valuearray of integer
integer
rangeStartobject

Start of the allowed daily time window. Hourly and custom schedules. Must be earlier than rangeEnd.

object
isEnabledboolean
valueobject
object
hoursinteger
minutesinteger
rangeEndobject

End of the allowed daily time window. Hourly and custom schedules.

object
isEnabledboolean
valueobject
object
hoursinteger
minutesinteger
isActiveboolean

Whether the schedule is enabled

botRunnerobject · nullable

The Bot Runner that runs this schedule. null uses the workflow's Bot Runner selection.

object
robotIdstringrequired

ID of a Bot Runner assigned to the workflow. An unassigned Bot Runner is rejected with 400.

busyPolicystring (queue, cancel)required

If the Bot Runner is busy: queue waits for it, cancel cancels this occurrence.

offlinePolicystring (fallback, cancel)required

If the Bot Runner is offline: fallback uses another assigned Bot Runner, cancel cancels this occurrence.

displayNamestring

Bot Runner name, set by the server.

accountEmailstring

Email of the account that created the schedule

statusstring (completed, completed-with-errors)

Result of the last execution. null before the first one.

nextRundate-time · nullable

Next occurrence, in UTC. Also calculated for disabled schedules, so check isActive.

lastRundate-time · nullable

Last execution, in UTC

lastErrorstring · nullable

Error of the last execution, if any

Example response
{
  "id": "663d9083ea1ba2debc1c410f",
  "workflow_id": "663d9083ea1ba2debc1c410d",
  "type": "direct",
  "timezoneLocation": "America/Sao_Paulo",
  "params": {
    "directDateTime": "2099-10-07T09:30:00"
  },
  "isActive": false,
  "botRunner": null,
  "accountEmail": "api-issuer@example.com",
  "status": null,
  "nextRun": "2099-10-07T12:30:00.000Z",
  "lastRun": null,
  "lastError": null
}
400Invalid ID or schedule parameters, or a Bot Runner that isn't assigned to the workflow

No response body.

401Missing or invalid API key

No response body.

403The API key's user lacks the required permission

No response body.

404Workflow or schedule not found in this Orchestrator

No response body.

Updated
Get Schedule InfoUpdate Schedule