Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions data/reusables/webhooks/workflow_job_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@ Key | Type | Description
----|------|-------------
`action`|`string` | The action performed. Can be one of: <ul><li> `queued` - A new job was created.</li><li> `in_progress` - The job has started processing on the runner.</li><li> `completed` - The `status` of the job is `completed`.</li></ul>
`workflow_job`|`object`| The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object.
`workflow_job[status]`|`string`| The current status of the job. Can be `queued`, `in_progress`, or `completed`.
`workflow_job[labels]`|`array`| Custom labels for the job. Specified by the [`"runs-on"` attribute](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.
`workflow_job[runner_id]`|`integer`| The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.
`workflow_job[runner_name]`|`string`| The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.
`workflow_job[runner_group_id]`|`integer`| The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.
`workflow_job[runner_group_name]`|`string`| The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.
13 changes: 10 additions & 3 deletions lib/webhooks/static/dotcom/workflow_job.payload.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"action": "queued",
"action": "in_progress",
"workflow_job": {
"id": 2832853555,
"run_id": 940463255,
Expand All @@ -8,13 +8,20 @@
"head_sha": "e3103f8eb03e1ad7f2331c5446b23c070fc54055",
"url": "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555",
"html_url": "https://github.com/octo-org/example-workflow/runs/2832853555",
"status": "queued",
"status": "in_progress",
"conclusion": null,
"started_at": "2021-06-15T19:22:27Z",
"completed_at": null,
"name": "Test workflow",
"steps": [

{
"name": "Set up job",
"status": "in_progress",
"conclusion": null,
"number": 1,
"started_at": "2021-06-15T19:22:27.000Z",
"completed_at": null
}
],
"check_run_url": "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555",
"labels": [
Expand Down