Request Pull Request Reviewers
github.request_pull_request_reviewers
ActionBusiness appsconnection required
Calls POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers.
Ask users or teams to review a pull request.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- GitHub
- Secret shape
- the GitHub personal access token
- Resolved by
- config.connection_id, else node.connection_id, else the tenant's sole GitHub connection
Configuration
5 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
owner Repository owner — the user or organisation login. Supports {{ }}. | string | Yes | — | — | octocat |
repo Repository name, without the owner prefix. Supports {{ }}. | string | Yes | — | — | hello-world |
pull_number Pull request number as shown in the UI (not the internal id). | string | Yes | — | — | 1 |
reviewers GitHub usernames to request, as a JSON array or a comma-separated list. | array | No | — | array of string | ["octocat"] |
team_reviewers Team slugs to request, as a JSON array or a comma-separated list. | array | No | — | array of string | ["core-team"] |
- At least one of reviewers, team_reviewers must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"owner": "octocat",
"pull_number": "1",
"repo": "hello-world",
"reviewers": [
"octocat"
],
"team_reviewers": [
"core-team"
]
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok True when GitHub accepted the call. | boolean | true |
reviewers Usernames now requested on the pull request. | array | — |
team_reviewers Team slugs now requested on the pull request. | array | — |
{
"ok": true,
"reviewers": [],
"team_reviewers": []
}Solutions with GitHub
See Request Pull Request Reviewers run in a workflow.
In a technical demo we add the GitHub connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.