curl -X POST 'https://api.github.com/repos/example-owner/example-repo/actions/workflows/10/dispatches' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "ref": "example-ref"
}'

# POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches (GitHub API)
Base URL: https://api.github.com
Auth: Authorization; GitHub token; required.
Request formats: application/json.
Last verified: 2026-10-20

> Create a workflow dispatch event

## Critical Gotchas
* GitHub recommends an `Accept: application/vnd.github+json` header and an explicit `X-GitHub-Api-Version` header.
* Fine-grained tokens only authorize repositories and permissions selected when the token is created.

## cURL
curl -X POST 'https://api.github.com/repos/example-owner/example-repo/actions/workflows/10/dispatches' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "ref": "example-ref"
}'

## Parameters
| Name | In | Type | Required | Description |
| :--- | :--- | :--- | :--- | :--- |
| owner | path | string | Yes | The account owner of the repository. The name is not case sensitive. |
| repo | path | string | Yes | The name of the repository without the `.git` extension. The name is not case... |
| workflow_id | path | integer | Yes | The ID of the workflow. You can also pass the workflow file name as a string. |
| ref | body | string | Yes | The git reference for the workflow. The reference can be a branch or tag name. |
| inputs | body | object | No | Input keys and values configured in the workflow file. The maximum number of... |

## Response example
{"workflow_run_id":0,"run_url":"https://example.com","html_url":"https://example.com"}

---
Need an API key? Get one at https://github.com/settings/tokens

POST

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

GitHub token (required); https://api.github.com

GitHub API

Create a workflow dispatch event

Base URL: https://api.github.com
Auth: Authorization: Bearer <GITHUB_API_KEY>
Last verified: 2026-10-20 · upstream hash matched

Actions Try in browser→

Agents: curl -H "Accept: text/markdown" this URL
→ 312 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X POST 'https://api.github.com/repos/example-owner/example-repo/actions/workflows/10/dispatches' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10' \  -H 'Content-Type: application/json' \  -d '{  "ref": "example-ref"}'

Parameters

Name	In	Type	Required	Description
owner	path	string	Yes	The account owner of the repository. The name is not case sensitive.
repo	path	string	Yes	The name of the repository without the `.git` extension. The name is not case sensitive.
workflow_id	path	integer	Yes	The ID of the workflow. You can also pass the workflow file name as a string.
ref	body	string	Yes	The git reference for the workflow. The reference can be a branch or tag name.
inputs	body	object	No	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.

Response 200 OK

{
  "workflow_run_id": 0,
  "run_url": "https://example.com",
  "html_url": "https://example.com"
}

Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.