Docs
API 1.39
Status
Objects

Schedule

The Schedule object of the Kaabist API.

FieldTypeRequiredDescription
idstringyespattern ^sch_[0-9a-hjkmnp-tv-z]{26}$
object"schedule"yes
programstringyes
inputsobject or nullyes
cronstringyespattern ^\S+\s+\S+\s+\S+\s+\S+\s+\S+$
timezonestringyesmin length 1
status"active", "paused"yes
paused_reason"manual", "credits", nullyes
mode"live", "test"yes
change_detectionobjectyes
change_detection.enabledbooleanyes
change_detection.fieldsstring
overlap_policy"skip", "queue"yes
catch_upbooleanyes
webhook_urlstring or null (uri)yes
last_run_atstring or null (date-time)yes
next_run_atstring or null (date-time)yes
created_atstring (date-time)yes

#Example

{
  "id": "sch_01j9zqk3q7m4n5p6r7s8t9v0wx",
  "object": "schedule",
  "program": "acme-report@production",
  "inputs": {
    "report_id": "42"
  },
  "cron": "*/30 * * * *",
  "timezone": "Europe/Istanbul",
  "status": "active",
  "paused_reason": null,
  "mode": "live",
  "change_detection": {
    "enabled": true,
    "fields": [
      "price"
    ]
  },
  "overlap_policy": "skip",
  "catch_up": false,
  "webhook_url": "https://hooks.acme.test/kaab",
  "last_run_at": "2026-09-18T10:00:00Z",
  "next_run_at": "2026-09-18T10:30:00Z",
  "created_at": "2026-09-18T10:00:00Z"
}

Was this page helpful?