release prereleased event

APIs.ioEngineeringPlatform

Properties

Name Type Description
action string
enterprise object
installation object
organization object
release object The [release](https://docs.github.com/[email protected]/rest/releases/releases/#get-a-release) object.
repository object
sender object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-webhook-release-prereleased-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/webhook-release-prereleased",
  "title": "release prereleased event",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "prereleased"
      ]
    },
    "enterprise": {
      "$ref": "#/components/schemas/enterprise-webhooks"
    },
    "installation": {
      "$ref": "#/components/schemas/simple-installation"
    },
    "organization": {
      "$ref": "#/components/schemas/organization-simple-webhooks"
    },
    "release": {
      "title": "Release",
      "description": "The [release](https://docs.github.com/[email protected]/rest/releases/releases/#get-a-release) object.",
      "type": "object",
      "required": [
        "assets",
        "assets_url",
        "author",
        "body",
        "created_at",
        "draft",
        "html_url",
        "id",
        "name",
        "node_id",
        "prerelease",
        "published_at",
        "tag_name",
        "tarball_url",
        "target_commitish",
        "upload_url",
        "url",
        "zipball_url"
      ],
      "properties": {
        "assets": {
          "type": "array",
          "items": {
            "title": "Release Asset",
            "description": "Data related to a release.",
            "type": "object",
            "required": [
              "url",
              "browser_download_url",
              "id",
              "node_id",
              "name",
              "label",
              "state",
              "content_type",
              "size",
              "download_count",
              "created_at",
              "updated_at"
            ],
            "nullable": true,
            "properties": {
              "browser_download_url": {
                "type": "string",
                "format": "uri"
              },
              "content_type": {
                "type": "string"
              },
              "created_at": {
                "type": "string",
                "format": "date-time"
              },
              "download_count": {
                "type": "integer"
              },
              "id": {
                "type": "integer"
              },
              "label": {
                "type": "string",
                "nullable": true
              },
              "name": {
                "description": "The file name of the asset.",
                "type": "string"
              },
              "node_id": {
                "type": "string"
              },
              "size": {
                "type": "integer"
              },
              "state": {
                "description": "State of the release asset.",
                "type": "string",
                "enum": [
                  "uploaded"
                ]
              },
              "updated_at": {
                "type": "string",
                "format": "date-time"
              },
              "uploader": {
                "title": "User",
                "type": "object",
                "nullable": true,
                "required": [
                  "login",
                  "id"
                ],
                "properties": {
                  "avatar_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "deleted": {
                    "type": "boolean"
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "events_url": {
                    "type": "string",
                    "format": "uri-template"
                  },
                  "followers_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "following_url": {
                    "type": "string",
                    "format": "uri-template"
                  },
                  "gists_url": {
                    "type": "string",
                    "format": "uri-template"
                  },
                  "gravatar_id": {
                    "type": "string"
                  },
                  "html_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "id": {
                    "type": "integer"
                  },
                  "login": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "node_id": {
                    "type": "string"
                  },
                  "organizations_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "received_events_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "repos_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "site_admin": {
                    "type": "boolean"
                  },
                  "starred_url": {
                    "type": "string",
                    "format": "uri-template"
                  },
                  "subscriptions_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "Bot",
                      "User",
                      "Organization"
                    ]
                  },
                  "url": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              },
              "url": {
                "type": "string",
                "format": "uri"
              }
            }
          }
        },
        "assets_url": {
          "type": "string",
          "format": "uri"
        },
        "author": {
          "title": "User",
          "type": "object",
          "nullable": true,
          "required": [
            "login",
            "id"
          ],
          "properties": {
            "avatar_url": {
              "type": "string",
              "format": "uri"
            },
            "deleted": {
              "type": "boolean"
            },
            "email": {
              "type": "string",
              "nullable": true
            },
            "events_url": {
              "type": "string",
              "format": "uri-template"
            },
            "followers_url": {
              "type": "string",
              "format": "uri"
            },
            "following_url": {
              "type": "string",
              "format": "uri-template"
            },
            "gists_url": {
              "type": "string",
              "format": "uri-template"
            },
            "gravatar_id": {
              "type": "string"
            },
            "html_url": {
              "type": "string",
              "format": "uri"
            },
            "id": {
              "type": "integer"
            },
            "login": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "node_id": {
              "type": "string"
            },
            "organizations_url": {
              "type": "string",
              "format": "uri"
            },
            "received_events_url": {
              "type": "string",
              "format": "uri"
            },
            "repos_url": {
              "type": "string",
              "format": "uri"
            },
            "site_admin": {
              "type": "boolean"
            },
            "starred_url": {
              "type": "string",
              "format": "uri-template"
            },
            "subscriptions_url": {
              "type": "string",
              "format": "uri"
            },
            "type": {
              "type": "string",
              "enum": [
                "Bot",
                "User",
                "Organization"
              ]
            },
            "url": {
              "type": "string",
              "format": "uri"
            }
          }
        },
        "body": {
          "type": "string",
          "nullable": true
        },
        "created_at": {
          "type": "string",
          "nullable": true,
          "format": "date-time"
        },
        "discussion_url": {
          "type": "string",
          "format": "uri"
        },
        "draft": {
          "description": "Whether the release is a draft or published",
          "type": "boolean"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string",
          "nullable": true
        },
        "node_id": {
          "type": "string"
        },
        "prerelease": {
          "description": "Whether the release is identified as a prerelease or a full release.",
          "type": "boolean",
          "enum": [
            true
          ]
        },
        "published_at": {
          "type": "string",
          "nullable": true,
          "format": "date-time"
        },
        "reactions": {
          "title": "Reactions",
          "type": "object",
          "required": [
            "url",
            "total_count",
            "+1",
            "-1",
            "laugh",
            "confused",
            "heart",
            "hooray",
            "eyes",
            "rocket"
          ],
          "properties": {
            "+1": {
              "type": "integer"
            },
            "-1": {
              "type": "integer"
            },
            "confused": {
              "type": "integer"
            },
            "eyes": {
              "type": "integer"
            },
            "heart": {
              "type": "integer"
            },
            "hooray": {
              "type": "integer"
            },
            "laugh": {
              "type": "integer"
            },
            "rocket": {
              "type": "integer"
            },
            "total_count": {
              "type": "integer"
            },
            "url": {
              "type": "string",
              "format": "uri"
            }
          }
        },
        "tag_name": {
          "description": "The name of the tag.",
          "type": "string"
        },
        "tarball_url": {
          "type": "string",
          "nullable": true,
          "format": "uri"
        },
        "target_commitish": {
          "description": "Specifies the commitish value that determines where the Git tag is created from.",
          "type": "string"
        },
        "upload_url": {
          "type": "string",
          "format": "uri-template"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "zipball_url": {
          "type": "string",
          "nullable": true,
          "format": "uri"
        }
      }
    },
    "repository": {
      "$ref": "#/components/schemas/repository-webhooks"
    },
    "sender": {
      "$ref": "#/components/schemas/simple-user-webhooks"
    }
  },
  "required": [
    "action",
    "release",
    "repository"
  ]
}