Describe the need
NOTE: https://docs.github.com/en/rest/actions/workflows?apiVersion=2026-03-10#create-a-workflow-dispatch-event documentation is partially inaccurate. The response data is correct but isn't clear about how to opt into the new behavior. See my notes below for how it works in practice.
This request tracks supporting new Create workflow dispatch event REST API support for returning the run_url and html_url entries for the newly-created workflow run.
The new behavior for this is:
- If you pass
X-GitHub-Api-Version header value of 2026-03-10, you automatically get the new response body
- Otherwise, according to this blog post and my own testing, you have to pass flag
return_run_details=true in the request to get the new response body
SDK Version
No response
API Version
No response
Relevant log output
Code of Conduct
Describe the need
NOTE: https://docs.github.com/en/rest/actions/workflows?apiVersion=2026-03-10#create-a-workflow-dispatch-event documentation is partially inaccurate. The response data is correct but isn't clear about how to opt into the new behavior. See my notes below for how it works in practice.
This request tracks supporting new
Create workflow dispatch eventREST API support for returning therun_urlandhtml_urlentries for the newly-created workflow run.The new behavior for this is:
X-GitHub-Api-Versionheader value of2026-03-10, you automatically get the new response bodyreturn_run_details=truein the request to get the new response bodySDK Version
No response
API Version
No response
Relevant log output
Code of Conduct