GitHub Changelog:Workflow dispatch API now returns run IDs #717
Description
Workflow dispatch API now returns run IDs
When you trigger a workflow using the GitHub Actions workflow dispatch API endpoint, you’ll now have the option to receive metadata in the response that helps you map your request to the corresponding workflow run. Previously, this endpoint returned only a 204 No Content status code. Now, you can pass in a new optional boolean parameter, return_run_details, which will return a 200 OK response containing the workflow ID, API URL, and workflow URL. If you do not pass in this parameter, it will continue to return the current 204 No Content status code.
This capability is also supported within the GitHub CLI, as of v2.87.0. If you trigger a workflow dispatch via gh workflow run, GitHub CLI will now return the URL for the created run along with the gh run view command for viewing that run.
With this update, developers can easily identify which workflow runs originated from their API calls—no more extensive polling or building custom tracking solutions. This new parameter is currently available in the API, and the newest version of the GitHub CLI will also default return_run_details to true.
Learn more about the workflow dispatch API in the GitHub Actions documentation.
The post Workflow dispatch API now returns run IDs appeared first on The GitHub Blog.
🔗 View original changelog entry
📅 Published: Thu, 19 Feb 2026 22:39:37 +0000