v5

latestSwagger 2.0MIT2026-08-03485217850.7 KB
repository

Create a workflow dispatch event

post/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches

Path parameters

ownerstring required

owner of the repo

repostring required

name of the repo

workflow_idstring required

id of the workflow

Query parameters

return_run_detailsboolean

Whether the response should include the workflow run ID and URLs.

scoped_workflow_source_repo_idinteger

For a scoped workflow, the ID of the source repository providing it; omit or 0 for a repo-level workflow.

Request body

inputsobject
refstring required

Example request

{
  "ref": "refs/heads/main"
}

Response

RunDetails

html_urlstring
run_urlstring
workflow_run_idinteger