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."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see "Creating a personal access token for the command line."

curl --location --request POST 'https://api.github.com/repos///actions/workflows//dispatches' \ --header 'Content-Type: application/json' \ --data-raw '{ "inputs": { "home": "San Francisco, CA", "name": "Mona the Octocat" }, "ref": "topic-branch" }'

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

workflow_id

string

必需

The ID of the workflow. You can also pass the workflow file name as a string.

Body 参数application/json

inputs

object

可选

Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

额外字段

string

可选

ref

string

必需

The git reference for the workflow. The reference can be a branch or tag name.

示例

Create a workflow dispatch event

请求参数

返回响应