Dispatches API is deprecated, Scheduled to be removed on Fri, 10 Mar 2028

[marcofranssen]

Found following in workflow logs recently:

[@octokit/request] "POST https://api.github.com/repos/my-org/my-repo/actions/workflows/.github%2Fworkflows%2Fmy-workflow.yaml/dispatches" is deprecated. It is scheduled to be removed on Fri, 10 Mar 2028 00:00:00 GMT. See https://docs.github.com/en/rest/about-the-rest-api/api-versions

Using Codex GPT 5.5 I found following:

Note

It isn’t being replaced by a different endpoint.

The warning is about GitHub’s REST API version, not the workflow dispatch endpoint itself. The replacement is to call the same endpoint using the newer REST API version header:

X-GitHub-Api-Version: 2026-03-10

Same endpoint:

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

What changes in 2026-03-10: workflow dispatch now returns 200
with workflow run details, instead of the old 204; the old
return_run_details parameter is removed. GitHub documents this
as the breaking change for POST /repos/{owner}/{repo}/actions/
workflows/{workflow_id}/dispatches.

Sources:

• Workflow dispatch endpoint docs:

  https://docs.github.com/en/rest/actions/workflows#create-a-workflow-dispatch-event

• API versioning docs:

  https://docs.github.com/en/rest/about-the-rest-api/api-versions

• Breaking change:

  https://docs.github.com/en/rest/about-the-rest-api/breaking-changes