commit_comment created event

APIs.ioEngineeringPlatform

Properties

Name Type Description
action string The action performed. Can be `created`.
comment object The [commit comment](https://docs.github.com/[email protected]/rest/commits/comments#get-a-commit-comment) resource.
enterprise object
installation object
organization object
repository object
sender object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-webhook-commit-comment-created-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/webhook-commit-comment-created",
  "title": "commit_comment created event",
  "type": "object",
  "properties": {
    "action": {
      "description": "The action performed. Can be `created`.",
      "type": "string",
      "enum": [
        "created"
      ]
    },
    "comment": {
      "description": "The [commit comment](https://docs.github.com/[email protected]/rest/commits/comments#get-a-commit-comment) resource.",
      "type": "object",
      "properties": {
        "author_association": {
          "title": "AuthorAssociation",
          "description": "How the author is associated with the repository.",
          "type": "string",
          "enum": [
            "COLLABORATOR",
            "CONTRIBUTOR",
            "FIRST_TIMER",
            "FIRST_TIME_CONTRIBUTOR",
            "MANNEQUIN",
            "MEMBER",
            "NONE",
            "OWNER"
          ]
        },
        "body": {
          "description": "The text of the comment.",
          "type": "string"
        },
        "commit_id": {
          "description": "The SHA of the commit to which the comment applies.",
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "id": {
          "description": "The ID of the commit comment.",
          "type": "integer"
        },
        "line": {
          "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
          "type": "integer",
          "nullable": true
        },
        "node_id": {
          "description": "The node ID of the commit comment.",
          "type": "string"
        },
        "path": {
          "description": "The relative path of the file to which the comment applies.",
          "type": "string",
          "nullable": true
        },
        "position": {
          "description": "The line index in the diff to which the comment applies.",
          "type": "integer",
          "nullable": true
        },
        "reactions": {
          "title": "Reactions",
          "type": "object",
          "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"
            }
          },
          "required": [
            "url",
            "total_count",
            "+1",
            "-1",
            "laugh",
            "confused",
            "heart",
            "hooray",
            "eyes",
            "rocket"
          ]
        },
        "updated_at": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "user": {
          "title": "User",
          "type": "object",
          "nullable": true,
          "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",
              "format": "int64"
            },
            "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"
            }
          },
          "required": [
            "login",
            "id"
          ]
        }
      },
      "required": [
        "url",
        "html_url",
        "id",
        "node_id",
        "user",
        "position",
        "line",
        "path",
        "commit_id",
        "created_at",
        "updated_at",
        "author_association",
        "body"
      ]
    },
    "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"
    }
  },
  "required": [
    "action",
    "comment",
    "repository",
    "sender"
  ]
}