Schedules

Schedules define recurring task execution for bridges, such as syncing orders every 15 minutes or pulling shipment updates hourly. They use cron syntax for timing.

List Schedules

GET/api/schedules

List all schedules for the organization.

Requiredbridges:read

Returns a paginated list of schedules with their cron expression, bridge, and task details.

Query Parameters

Parameter	Type	Description
`page`	number	Page number (default: 1)
`limit`	number	Items per page (default: 20, max: 100)
`bridge_id`	string	Filter by bridge ID
`status`	string	Filter by status: `active`, `paused`


curl -X GET "https://api.orderly.dev/api/schedules?status=active" \
  -H "Authorization: Bearer ord_sk_..."

Response


{
  "data": [
    {
      "id": "uuid",
      "bridge_id": "uuid",
      "bridge_name": "Production Shopify",
      "task": "grab-orders",
      "cron": "*/15 * * * *",
      "status": "active",
      "last_run_at": "2026-01-15T10:15:00Z",
      "next_run_at": "2026-01-15T10:30:00Z",
      "created_at": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 6, "totalPages": 1, "hasMore": false }
}

Create Schedule

POST/api/schedules

Create a new recurring schedule for a bridge task.

Requiredbridges:write

Creates a new schedule. The bridge must be active and support the specified task.

Request Body

Field	Type	Required	Description
`bridge_id`	string	Yes	Bridge to schedule
`task`	string	Yes	Task to execute (e.g., `grab-orders`, `grab-shipments`)
`cron`	string	Yes	Cron expression (e.g., `/15 * * *` for every 15 minutes)
`status`	string	No	Initial status: `active` or `paused` (default: `active`)
`timezone`	string	No	IANA timezone (default: `UTC`)


curl -X POST "https://api.orderly.dev/api/schedules" \
  -H "Authorization: Bearer ord_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "bridge_id": "550e8400-e29b-41d4-a716-446655440000",
    "task": "grab-orders",
    "cron": "*/15 * * * *",
    "timezone": "America/New_York"
  }'

Update Schedule

PATCH/api/schedules/:id

Update a schedule's cron expression, task, or status.

Requiredbridges:write

Updates a schedule. Changing the cron expression takes effect at the next scheduled run.


curl -X PATCH "https://api.orderly.dev/api/schedules/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer ord_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"cron": "0 * * * *", "status": "paused"}'

Delete Schedule

DELETE/api/schedules/:id

Delete a schedule.

Requiredbridges:write

Permanently deletes a schedule. Any currently executing task will complete, but no future runs will be triggered.


curl -X DELETE "https://api.orderly.dev/api/schedules/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer ord_sk_..."