Create a workflow dispatch event

POST

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

const url = 'https://gitea.example.com/api/v1/repos/example/example/actions/workflows/example/dispatches';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"inputs":{"additionalProperty":"example"},"ref":"refs/heads/main"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://gitea.example.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

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

Request Body

CreateActionWorkflowDispatch represents the payload for triggering a workflow dispatch event

object

inputs

object

key

additional properties

string

ref

required

string

Example

refs/heads/main

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

204

No Content

application/json

400

APIError is error format response

application/json

Headers

message

string

url

string

403

APIForbiddenError is a forbidden error response

application/json

Headers

message

string

url

string

404

APINotFound is a not found empty response

application/json

422

APIValidationError is error format response related to input validation

application/json

Headers

message

string

url

string