Create a repository dispatch event
Start the default branch's workflows that run on: repository_dispatch for event_type (those listing it under types, or with none). client_payload, a JSON object of at most 10 properties and 64 KB, is github.event.client_payload; github.event.action is event_type.
POST
/repos/{owner}/{name}/dispatchesA workflow job’s own token may send one: with workflow_dispatch, it is how one workflow starts another. Needs the Write role (code:write). Returns how many runs started.
- Authentication: Required. Send an access token as
Authorization: Bearer. - MCP tool:
workflowwithactionrepository_dispatch, and the same inputs - Scope: An access token needs
code:write.
Path parameters
Section titled “Path parameters”| Name | Type | Required | Description |
|---|---|---|---|
owner |
string | Yes | The workspace that owns the repository. |
name |
string | Yes | The repository’s name. |
Body parameters
Section titled “Body parameters”Send a JSON object. Names are snake_case, as in responses; the camelCase spelling is accepted too.
| Name | Type | Required | Description |
|---|---|---|---|
event_type |
string | Yes | What happened, 1 to 100 characters; workflows choose it with types:. |
client_payload |
object | No | Anything the workflows should read, as github.event.client_payload. |
Example request
Section titled “Example request”curl -X POST https://api.g1t.sh/repos/flagon-io/g1t/dispatches \ -H "Authorization: Bearer $G1T_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "event_type": "docs-published", "client_payload": { "version": "2026.10.08" } }'Example response
Section titled “Example response”A successful request answers 200 with:
{ "runs": 1}Errors
Section titled “Errors”A failed request answers with one of these statuses and a body like {"error": {"code": "not_found", "message": "Repository not found."}}. See errors.
| Status | Code | When |
|---|---|---|
| 401 | unauthenticated |
A token is required, or the one sent is not valid. |
| 403 | forbidden |
The token is valid but not allowed to do this, such as a member-only change or an agent token outside its repository. |
| 404 | not_found |
It does not exist, or you cannot see it. |
| 409 | conflict |
The request conflicts with the current state. |
| 422 | invalid |
The input is not valid. message says which field and why. |