Sample - GitHub REST API
POST/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches

Create a workflow dispatch event

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see "Events that trigger workflows."

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters · 3 body fields
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
workflow_idintegerrequired
The ID of the workflow. You can also pass the workflow file name as a string.
refstringrequired
The git reference for the workflow. The reference can be a branch or tag name.
inputsobjectoptional
Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted.
return_run_detailsbooleanoptional
Whether the response should include the workflow run ID and URLs.

2 status codes
200Response including the workflow run ID and URLs when `return_run_details` parameter is `true`.
workflow_run_idintegerrequired
The ID of the workflow run.
run_urlstringrequired
The URL to the workflow run.
html_urlstringrequired
204Empty response when `return_run_details` parameter is `false`.