workflow_job queued event

APIs.ioEngineeringPlatform

Properties

Name Type Description
action string
enterprise object
installation object
organization object
repository object
sender object
workflow_job object
deployment object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-webhook-workflow-job-queued-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/webhook-workflow-job-queued",
  "title": "workflow_job queued event",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "queued"
      ]
    },
    "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": {
      "type": "object",
      "properties": {
        "check_run_url": {
          "type": "string",
          "format": "uri"
        },
        "completed_at": {
          "type": "string",
          "nullable": true
        },
        "conclusion": {
          "type": "string",
          "nullable": true
        },
        "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": {
          "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": {
          "type": "integer",
          "nullable": true
        },
        "runner_group_name": {
          "type": "string",
          "nullable": true
        },
        "runner_id": {
          "type": "integer",
          "nullable": true
        },
        "runner_name": {
          "type": "string",
          "nullable": true
        },
        "started_at": {
          "type": "string",
          "format": "date-time"
        },
        "status": {
          "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": [
                  "completed",
                  "in_progress",
                  "queued",
                  "pending"
                ]
              }
            },
            "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"
      ]
    },
    "deployment": {
      "$ref": "#/components/schemas/deployment"
    }
  },
  "required": [
    "action",
    "repository",
    "sender",
    "workflow_job"
  ]
}