Scheduler
Create and manage scheduled events, including action automations.
Scheduler API
List Events
GET
Required permission
scheduler_events:readApiAccessPermission::SCHEDULER_EVENTS_READQuery Parameters
startstringRequiredStart date or datetime (recommended YYYY-MM-DD).
endstringRequiredEnd date or datetime (recommended YYYY-MM-DD).
Responses
Events fetched in the requested range.
{
"status": "fetch",
"count": 2,
"range": {
"start": "2026-04-01T00:00:00+02:00",
"end": "2026-04-30T23:59:59+02:00"
},
"events": [
{
"id": "681f0f...",
"event_type": "appointment",
"title": "Quarterly Review",
"schedule_date": "2026-04-12T09:00:00+02:00",
"end_date": "2026-04-12T10:00:00+02:00"
}
]
}Create Event
POST
Required permission
scheduler_events:writeApiAccessPermission::SCHEDULER_EVENTS_WRITEQuery Parameters
No query parameters required.
Request Body
{
"event": {
"event_type": "action",
"title": "Run Workflow Daily",
"schedule_date": "2026-04-20T07:30:00+02:00",
"end_date": "2026-04-20T07:30:00+02:00",
"is_all_day": false,
"color": "primary",
"action_type": "workflow",
"action_details": {
"workflow_id": "67ffac1f8a3f0f2f88f9dd10",
"payload": {
"source": "api"
}
},
"recurrence": {
"type": "week",
"interval": 1,
"endDate": "2026-12-31"
}
}
}eventobjectRequiredScheduler event payload.
Responses
Event created.
{
"id": "681f0f...",
"event": {
"id": "681f0f...",
"event_type": "action",
"action_type": "workflow"
}
}Validation error on event payload.
{
"error": "Invalid \"action_type\". Allowed values: charge, job_runner, workflow"
}Update Event
PUT
Required permission
scheduler_events:writeApiAccessPermission::SCHEDULER_EVENTS_WRITEQuery Parameters
eventIdstringRequiredScheduler event identifier.
Request Body
{
"event": {
"title": "Run Workflow - Updated",
"recurrence": {
"type": "month",
"interval": 1,
"endDate": "2027-04-30"
}
}
}eventobjectRequiredPartial event payload to update.
Responses
Event updated.
{
"id": "681f0f...",
"event": {
"id": "681f0f...",
"title": "Run Workflow - Updated"
}
}Delete Event
DELETE
Required permission
scheduler_events:writeApiAccessPermission::SCHEDULER_EVENTS_WRITEQuery Parameters
eventIdstringRequiredScheduler event identifier.
Responses
Event deleted.
{
"id": "681f0f...",
"deleted": true
}