Create a workflow dispatch event

POST

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

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

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢204No Content

Response

このレスポンスにはボディがありません

リクエストExample

Shell

JavaScript

Java

Swift

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

更新日時 2025-06-12 06:47:19

Disable a workflow

Enable a workflow