APIs.io Engineering Platform · Schema

Enterprise

An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "[About enterprise accounts](https://docs.github.com/[email protected]/admin/overview/about-enterprise-accounts)."

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
description	string	A short description of the enterprise.
html_url	string
website_url	string	The enterprise's website URL.
id	integer	Unique identifier of the enterprise
node_id	string
name	string	The name of the enterprise.
slug	string	The slug url identifier for the enterprise.
created_at	string
updated_at	string
avatar_url	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/enterprise-webhooks",
  "title": "Enterprise",
  "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/[email protected]/admin/overview/about-enterprise-accounts).\"\n",
  "type": "object",
  "properties": {
    "description": {
      "description": "A short description of the enterprise.",
      "type": "string",
      "nullable": true
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/enterprises/octo-business"
    },
    "website_url": {
      "description": "The enterprise's website URL.",
      "type": "string",
      "nullable": true,
      "format": "uri"
    },
    "id": {
      "description": "Unique identifier of the enterprise",
      "example": 42,
      "type": "integer"
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
    },
    "name": {
      "description": "The name of the enterprise.",
      "type": "string",
      "example": "Octo Business"
    },
    "slug": {
      "description": "The slug url identifier for the enterprise.",
      "type": "string",
      "example": "octo-business"
    },
    "created_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time",
      "example": "2019-01-26T19:01:12Z"
    },
    "updated_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time",
      "example": "2019-01-26T19:14:43Z"
    },
    "avatar_url": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "id",
    "node_id",
    "name",
    "slug",
    "html_url",
    "created_at",
    "updated_at",
    "avatar_url"
  ]
}