Create a workflow dispatch event

POST

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

curl --request POST \
  --url https://gitea.com/api/v1/repos/example/example/actions/workflows/example/dispatches \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "inputs": { "additionalProperty": "example" }, "ref": "refs/heads/main" }'

Authorizations

• BasicAuth
• Token
• AccessToken
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

workflow_id

required

string

Id of the workflow

Query Parameters

return_run_details

boolean

Whether the response should include the workflow run ID and URLs.

scoped_workflow_source_repo_id

integer format: int64

For a scoped workflow, the ID of the source repository providing it; omit or 0 for a repo-level workflow.

Request Body

Media typeapplication/json

CreateActionWorkflowDispatch represents the payload for triggering a workflow dispatch event

object

inputs

object

key

additional properties

string

ref

required

string

Example

refs/heads/main

Responses

200

RunDetails

Media typeapplication/json

RunDetails returns workflow_dispatch runid and url

object

html_url

string format: uri

run_url

string format: uri

workflow_run_id

integer format: int64

Example^generated

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

204

No Content, if return_run_details is missing or false

400

APIError is error format response

Headers

message

string

url

string

403

APIForbiddenError is a forbidden error response

Headers

message

string

url

string

404

APINotFound is a not found empty response

422

APIValidationError is error format response related to input validation

Headers

message

string

url

string