GitHub Workflow Run Event

GitHub workflow_run webhook payload with run status, conclusion, and workflow tracking.

Report an issue
github

Install

$ npx shadcn@latest add @open-types/github-workflow-run-event

Dependencies

Source

import type {
  GitHubUser,
  GitHubRepository,
  GitHubOrganization,
} from "./github-shared";

export interface GitHubWorkflowRun {
  id: number;
  node_id: string;
  name: string;
  head_branch: string;
  head_sha: string;
  run_number: number;
  event: string;
  status: string | null;
  conclusion: string | null;
  workflow_id: number;
  url: string;
  html_url: string;
  created_at: string;
  updated_at: string;
  run_attempt: number;
  run_started_at: string;
}

export interface GitHubWorkflow {
  id: number;
  node_id: string;
  name: string;
  path: string;
  state: string;
  created_at: string;
  updated_at: string;
}

export type GitHubWorkflowRunEventAction =
  | "requested"
  | "completed"
  | "in_progress";

export interface GitHubWorkflowRunEvent {
  action: GitHubWorkflowRunEventAction;
  workflow_run: GitHubWorkflowRun;
  workflow: GitHubWorkflow;
  repository: GitHubRepository;
  sender: GitHubUser;
  organization?: GitHubOrganization;
}
import type {
  GitHubUser,
  GitHubRepository,
  GitHubOrganization,
} from "./github-shared";

export interface GitHubWorkflowRun {
  id: number;
  node_id: string;
  name: string;
  head_branch: string;
  head_sha: string;
  run_number: number;
  event: string;
  status: string | null;
  conclusion: string | null;
  workflow_id: number;
  url: string;
  html_url: string;
  created_at: string;
  updated_at: string;
  run_attempt: number;
  run_started_at: string;
}

export interface GitHubWorkflow {
  id: number;
  node_id: string;
  name: string;
  path: string;
  state: string;
  created_at: string;
  updated_at: string;
}

export type GitHubWorkflowRunEventAction =
  | "requested"
  | "completed"
  | "in_progress";

export interface GitHubWorkflowRunEvent {
  action: GitHubWorkflowRunEventAction;
  workflow_run: GitHubWorkflowRun;
  workflow: GitHubWorkflow;
  repository: GitHubRepository;
  sender: GitHubUser;
  organization?: GitHubOrganization;
}