schedules

Create a schedule

Schedules a recurring or one-time call to an API endpoint.

post/v1/schedules

Request

  • Base URL: https://api.olostep.com
  • URL: https://api.olostep.com/v1/schedules
  • Auth: HTTP bearer

Request body

method'GET' | 'POST' required

HTTP method for the scheduled call.

endpointstring required

The endpoint URL to call when the schedule executes.

payloadobject
cron_expressionstring

Cron expression for recurring schedules. Mutually exclusive with execute_at/text.

execute_atstring

ISO 8601 datetime for one-time execution. Mutually exclusive with cron_expression/text.

expression_timezonestring
textstring

Natural language text to generate a cron expression from.

Response

Default Response

idstring required
object'schedule' required
type'recurring' | 'onetime' required
method'GET' | 'POST' required
endpointstring required
cron_expressionstring
execute_atstring
expression_timezonestring
createdinteger nullable required

Unix timestamp in seconds when the schedule was created.

Changes

No recorded changes to this operation across all 3 revisions of this API.