Skip to content
forgit api docs

Dispatches a workflow

POST
/repos/{owner}/{repo}/actions/workflows/{workflowfilename}/dispatches

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

workflowfilename
required
string

Name of the workflow

Request Body

Section titled “ Request Body ”
Media type application/json

DispatchWorkflowOption options when dispatching a workflow

object
inputs

Input keys and values configured in the workflow file.

object
key
additional properties
string
ref
required

Git reference for the workflow

string
return_run_info

Flag to return the run info

boolean

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

DispatchWorkflowRun is a Workflow Run after dispatching

DispatchWorkflowRun represents a workflow run

object
id

The workflow run id

integer format: int64
jobs

The jobs name

Array<string>
run_number

A unique number for each run of a repository

integer format: int64
Example generated 
{
  "id": 1,
  "jobs": [
    "example"
  ],
  "run_number": 1
}

204

Section titled “ 204 ”

APIEmpty is an empty response

404

Section titled “ 404 ”

APINotFound is a not found error response

object
errors
Array<string>
message
string
url
string
Example generated 
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}