Sign in
workflow-schedules

Trigger a workflow run from a workflow schedule.

Changed on

Creates a WorkflowRun from the addressed WorkflowSchedule without overriding any schedule-derived execution fields.

post/api/workflow/{agentName}/{workflowName}/schedule/{scheduleName}/run

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workflow/{agentName}/{workflowName}/schedule/{scheduleName}/run
  • Auth: HTTP bearer

Path parameters

agentNamestring required

Agent name.

workflowNamestring required

Workflow name scoped to an agent.

scheduleNamestring required

WorkflowSchedule resource name.

Response

Workflow run accepted.

namestring required

WorkflowRun resource name.

workflow_namestring required

Workflow name scoped to an agent.

trigger_type'Schedule' | 'Webhook' required
schedule_namestring

WorkflowSchedule resource name.

timeout_secondsinteger required
status'Pending' | 'Running' | 'Succeeded' | 'Failed' | 'Unacked' required
reasonstring required
created_atstring date-time required
started_atstring date-time
completed_atstring date-time
duration_secondsinteger

Changes

  • d197d7b57b8dRevision changes
    • info

      added the non-success response with the status

  • d44ac82920cdRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status