POST

Try POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches — GitHub API

GitHub playground

Create a workflow dispatch event

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive. workflow_id · required · integer The ID of the workflow. You can also pass the workflow file name as a string.

Body application/json

2 body fields

ref · required · string — The git reference for the workflow. The reference can be a branch or tag name.
inputs · optional · object — 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.