{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhook-workflow-job-completed",
"title": "workflow_job completed event",
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"completed"
]
},
"enterprise": {
"$ref": "#/components/schemas/enterprise-webhooks"
},
"installation": {
"$ref": "#/components/schemas/simple-installation"
},
"organization": {
"$ref": "#/components/schemas/organization-simple-webhooks"
},
"repository": {
"$ref": "#/components/schemas/repository-webhooks"
},
"sender": {
"$ref": "#/components/schemas/simple-user-webhooks"
},
"workflow_job": {
"allOf": [
{
"title": "Workflow Job",
"description": "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.",
"type": "object",
"properties": {
"check_run_url": {
"type": "string",
"format": "uri"
},
"completed_at": {
"type": "string",
"nullable": true
},
"conclusion": {
"type": "string",
"nullable": true,
"enum": [
"success",
"failure",
null,
"skipped",
"cancelled",
"action_required",
"neutral",
"timed_out"
]
},
"created_at": {
"description": "The time that the job created.",
"type": "string"
},
"head_sha": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"labels": {
"description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/[email protected]/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.",
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"run_attempt": {
"type": "integer"
},
"run_id": {
"type": "number"
},
"run_url": {
"type": "string",
"format": "uri"
},
"runner_group_id": {
"description": "The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
"type": "integer",
"nullable": true
},
"runner_group_name": {
"description": "The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
"type": "string",
"nullable": true
},
"runner_id": {
"description": "The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
"type": "integer",
"nullable": true
},
"runner_name": {
"description": "The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
"type": "string",
"nullable": true
},
"started_at": {
"type": "string"
},
"status": {
"description": "The current status of the job. Can be `queued`, `in_progress`, `waiting`, or `completed`.",
"type": "string",
"enum": [
"queued",
"in_progress",
"completed",
"waiting"
]
},
"head_branch": {
"type": "string",
"description": "The name of the current branch.",
"nullable": true
},
"workflow_name": {
"type": "string",
"description": "The name of the workflow.",
"nullable": true
},
"steps": {
"type": "array",
"items": {
"title": "Workflow Step",
"type": "object",
"properties": {
"completed_at": {
"type": "string",
"nullable": true
},
"conclusion": {
"type": "string",
"nullable": true,
"enum": [
"failure",
"skipped",
"success",
"cancelled",
null
]
},
"name": {
"type": "string"
},
"number": {
"type": "integer"
},
"started_at": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"in_progress",
"completed",
"queued"
]
}
},
"required": [
"name",
"status",
"conclusion",
"number",
"started_at",
"completed_at"
]
}
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"run_id",
"run_url",
"run_attempt",
"node_id",
"head_sha",
"url",
"html_url",
"status",
"conclusion",
"started_at",
"completed_at",
"name",
"steps",
"check_run_url",
"labels",
"runner_id",
"runner_name",
"runner_group_id",
"runner_group_name",
"workflow_name",
"head_branch",
"created_at"
]
},
{
"type": "object",
"properties": {
"check_run_url": {
"type": "string"
},
"completed_at": {
"type": "string"
},
"conclusion": {
"type": "string",
"enum": [
"success",
"failure",
"skipped",
"cancelled",
"action_required",
"neutral",
"timed_out"
]
},
"created_at": {
"description": "The time that the job created.",
"type": "string"
},
"head_sha": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"labels": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"run_attempt": {
"type": "integer"
},
"run_id": {
"type": "integer"
},
"run_url": {
"type": "string"
},
"runner_group_id": {
"type": "number",
"nullable": true
},
"runner_group_name": {
"type": "string",
"nullable": true
},
"runner_id": {
"type": "number",
"nullable": true
},
"runner_name": {
"type": "string",
"nullable": true
},
"started_at": {
"type": "string"
},
"status": {
"type": "string"
},
"head_branch": {
"type": "string",
"description": "The name of the current branch.",
"nullable": true
},
"workflow_name": {
"type": "string",
"description": "The name of the workflow.",
"nullable": true
},
"steps": {
"type": "array",
"items": {
"type": "object",
"nullable": true
}
},
"url": {
"type": "string"
}
},
"required": [
"conclusion"
]
}
]
},
"deployment": {
"$ref": "#/components/schemas/deployment"
}
},
"required": [
"action",
"repository",
"sender",
"workflow_job"
]
}