Sign in

v5

OpenAPI 3.1.02026-07-31129337684.6 KB
Workflow Schedules

Create Workflow Schedule

Schedule a workflow to run at a future time.

post/workflows/v1/workflows/{workflow_id}/schedules

Path parameters

workflow_idstring required
Example:5eb7cf5a86d9755df3a6c593

Request body

scheduled_timestring date-time required

Scheduled time in UTC

versioninteger nullable
scheduled_by_namestring nullable

Display name of the user creating the schedule

Example request

{
  "run_input": {
    "workflow_id": "5eb7cf5a86d9755df3a6c593",
    "workflow_run_id": "5eb7cf5a86d9755df3a6c593"
  }
}

Response

Successful Response

team_idstring nullable

ID of the team that owns this edge

created_bystring nullable

ID of the user who created this edge

updated_bystring nullable

ID of the user who last updated this edge

created_atstring date-time
updated_atstring date-time
_idstring
workflow_idstring required
status'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled'
scheduled_timestring date-time required

The target time for the workflow execution (UTC)

versioninteger nullable

Version of the workflow to run

schedule_namestring nullable

AWS EventBridge Schedule name (used for deletion)

scheduler_arnstring nullable

AWS EventBridge Scheduler ARN

actual_run_idstring
scheduled_by_namestring nullable

Display name of the user who created the schedule

error_messagestring nullable

Error message if the schedule failed to execute

Example response

{
  "_id": "5eb7cf5a86d9755df3a6c593",
  "workflow_id": "5eb7cf5a86d9755df3a6c593",
  "actual_run_id": "5eb7cf5a86d9755df3a6c593"
}