Get a GitHub workflow run | New Relic Documentation

Retrieves the details, status, and conclusion of a specific GitHub Actions workflow run by its numeric Run ID. The Run ID is typically obtained from a prior gitHub.workflowRun.trigger or gitHub.workflowRun.list step.

For authentication setup, see GitHub workflow run actions.

The following inputs are available for this action.

Input	Type	Description	Example
token	String	Required. GitHub Personal Access Token stored as a secret. Fine-grained PATs require Actions: read permission. Classic PATs require repo scope.	`"${{ :secrets:github-PAT-token }}"`
owner	String	Required. The account owner of the repository (user or organization login). Case-insensitive.	`"octocat"`
repo	String	Required. Repository name without the .git suffix. Case-insensitive.	`"Hello-World"`
runId	Int	Required. The unique numeric ID of the workflow run. Must be a positive integer.	`35064429580`
excludePullRequests	Boolean	Optional. If `true`, pull request information is omitted from the response. Default: `false`.	`false`
selectors	List	Optional. JQ selectors to extract values from the response. Common selectors: `.status`, `.conclusion`, `.html_url`.	`[{"name": "conclusion", "expression": ".conclusion"}]`

This action returns the following outputs.

Output	Type	Example
response	Object	`{ "id": 35064429580, "name": "Deploy to staging", "status": "completed", "conclusion": "success", "html_url": "https://github.com/owner/repo/actions/runs/35064429580", "run_number": 15, "event": "workflow_dispatch", "head_branch": "main", "head_sha": "5cd968b93ae41f708cd094303e80bd4fca09d980", "created_at": "2026-09-16T06:35:42Z", "updated_at": "2026-09-16T06:35:50Z", "actor": { "login": "octocat" }, "workflow_id": 357740374 }`
success	Boolean	`success: true \| false`
errorMessage	String	Contains the GitHub API error response body.

Output

Type

Example

response

Object

{
  "id": 35064429580,
  "name": "Deploy to staging",
  "status": "completed",
  "conclusion": "success",
  "html_url": "https://github.com/owner/repo/actions/runs/35064429580",
  "run_number": 15,
  "event": "workflow_dispatch",
  "head_branch": "main",
  "head_sha": "5cd968b93ae41f708cd094303e80bd4fca09d980",
  "created_at": "2026-09-16T06:35:42Z",
  "updated_at": "2026-09-16T06:35:50Z",
  "actor": { "login": "octocat" },
  "workflow_id": 357740374
}

success

Boolean

success: true | false

errorMessage

String

Contains the GitHub API error response body.

Workflow example
`name: poll_workflow_run description: Get the status of a specific GitHub Actions workflow run steps: - name: get_run type: action action: gitHub.workflowRun.get version: 1 inputs: token: ${{ :secrets:github-PAT-token }} owner: your_user_name repo: test-workflow runId: ${{ .steps.trigger_run.outputs.response.workflow_run_id }} selectors: - name: status expression: ".status" - name: conclusion expression: ".conclusion" - name: htmlUrl expression: ".html_url" next: end`

Workflow example

name: poll_workflow_run
description: Get the status of a specific GitHub Actions workflow run
steps:
  - name: get_run
    type: action
    action: gitHub.workflowRun.get
    version: 1
    inputs:
      token: ${{ :secrets:github-PAT-token }}
      owner: your_user_name
      repo: test-workflow
      runId: ${{ .steps.trigger_run.outputs.response.workflow_run_id }}
      selectors:
        - name: status
          expression: ".status"
        - name: conclusion
          expression: ".conclusion"
        - name: htmlUrl
          expression: ".html_url"
    next: end