All branch protections were disabled for a repository.
", "summaryHtml": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"About protected branches.\"\nFor information about using the APIs to manage branch protection rules, see \"Branch protection rule\" in the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "disabled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "disabled", "category": "branch_protection_configuration" }, "enabled": { "descriptionHtml": "All branch protections were enabled for a repository.
", "summaryHtml": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"About protected branches.\"\nFor information about using the APIs to manage branch protection rules, see \"Branch protection rule\" in the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "enabled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "enabled", "category": "branch_protection_configuration" } }, "branch_protection_rule": { "created": { "descriptionHtml": "A branch protection rule was created.
", "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
The enforcement level of the branch lock setting. off means the branch is not locked, non_admins means the branch is read-only for non_admins, and everyone means the branch is read-only for everyone.
Whether users can pull changes from upstream when the branch is locked. Set to true to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.
Whether the most recent push must be approved by someone other than the person who pushed it
" }, { "type": "integer", "name": "required_approving_review_count", "description": "", "isRequired": true }, { "type": "string", "name": "required_conversation_resolution_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "string", "name": "required_deployments_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "array of strings", "name": "required_status_checks", "description": "", "isRequired": true }, { "type": "string", "name": "required_status_checks_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "string", "name": "signature_requirement_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "branch_protection_rule" }, "deleted": { "descriptionHtml": "A branch protection rule was deleted.
", "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
The enforcement level of the branch lock setting. off means the branch is not locked, non_admins means the branch is read-only for non_admins, and everyone means the branch is read-only for everyone.
Whether users can pull changes from upstream when the branch is locked. Set to true to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.
Whether the most recent push must be approved by someone other than the person who pushed it
" }, { "type": "integer", "name": "required_approving_review_count", "description": "", "isRequired": true }, { "type": "string", "name": "required_conversation_resolution_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "string", "name": "required_deployments_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "array of strings", "name": "required_status_checks", "description": "", "isRequired": true }, { "type": "string", "name": "required_status_checks_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "string", "name": "signature_requirement_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "branch_protection_rule" }, "edited": { "descriptionHtml": "A branch protection rule was edited.
", "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "If the action was edited, the changes to the rule.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
The enforcement level of the branch lock setting. off means the branch is not locked, non_admins means the branch is read-only for non_admins, and everyone means the branch is read-only for everyone.
Whether users can pull changes from upstream when the branch is locked. Set to true to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.
Whether the most recent push must be approved by someone other than the person who pushed it
" }, { "type": "integer", "name": "required_approving_review_count", "description": "", "isRequired": true }, { "type": "string", "name": "required_conversation_resolution_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "string", "name": "required_deployments_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "array of strings", "name": "required_status_checks", "description": "", "isRequired": true }, { "type": "string", "name": "required_status_checks_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "string", "name": "signature_requirement_enforcement_level", "description": "", "isRequired": true, "enum": [ "off", "non_admins", "everyone" ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "branch_protection_rule" } }, "bypass_request_secret_scanning": { "cancelled": { "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "cancelled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "cancelled", "category": "bypass_request_secret_scanning" }, "completed": { "descriptionHtml": "A secret scanning bypass request was completed.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "completed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "completed", "category": "bypass_request_secret_scanning" }, "created": { "descriptionHtml": "A secret scanning push protection bypass request was created.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "bypass_request_secret_scanning" }, "response_dismissed": { "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "response_dismissed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "exemption_response", "in": "body", "description": "A response to an exemption request by a delegated bypasser.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "response_dismissed", "category": "bypass_request_secret_scanning" }, "response_submitted": { "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "response_submitted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "exemption_response", "in": "body", "description": "A response to an exemption request by a delegated bypasser.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "response_submitted", "category": "bypass_request_secret_scanning" } }, "cache_sync": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", "bodyParameters": [ { "type": "string", "name": "after", "in": "body", "description": "", "isRequired": true }, { "type": "string", "name": "before", "in": "body", "description": "", "isRequired": true }, { "type": "string", "name": "cache_location", "in": "body", "description": "", "isRequired": true }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "cache_sync" } }, "check_run": { "completed": { "descriptionHtml": "A check run was completed, and a conclusion is available.
", "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
A check performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "client_id", "description": "" }, { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "Simple User", "description": "A GitHub user.
", "isRequired": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "Enterprise", "description": "An enterprise on GitHub.
", "isRequired": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ], "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "A short description of the enterprise.
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "website_url", "description": "The enterprise's website URL.
" }, { "type": "integer", "name": "id", "description": "Unique identifier of the enterprise
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the enterprise.
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug url identifier for the enterprise.
", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true } ] } ], "oneOfObject": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "external_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "issues", "description": "" }, { "type": "string", "name": "checks", "description": "" }, { "type": "string", "name": "metadata", "description": "" }, { "type": "string", "name": "contents", "description": "" }, { "type": "string", "name": "deployments", "description": "" } ] }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" } ] }, { "type": "object", "name": "check_suite", "description": "A suite of checks performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "after", "description": "" }, { "type": "object or null", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "client_id", "description": "" }, { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "Simple User", "description": "A GitHub user.
", "isRequired": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "Enterprise", "description": "An enterprise on GitHub.
", "isRequired": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ], "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "A short description of the enterprise.
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "website_url", "description": "The enterprise's website URL.
" }, { "type": "integer", "name": "id", "description": "Unique identifier of the enterprise
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the enterprise.
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug url identifier for the enterprise.
", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true } ] } ], "oneOfObject": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "external_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "issues", "description": "" }, { "type": "string", "name": "checks", "description": "" }, { "type": "string", "name": "metadata", "description": "" }, { "type": "string", "name": "contents", "description": "" }, { "type": "string", "name": "deployments", "description": "" } ] }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" } ] }, { "type": "string or null", "name": "before", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", "stale", "startup_failure", null ] }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string or null", "name": "head_branch", "description": "" }, { "type": "string", "name": "head_sha", "description": "The SHA of the head commit that is being checked.
" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "repository", "description": "Minimal Repository
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "" }, { "type": "string or null", "name": "mirror_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "" }, { "type": "string or null", "name": "homepage", "description": "" }, { "type": "string or null", "name": "language", "description": "" }, { "type": "integer", "name": "forks_count", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "" }, { "type": "integer", "name": "watchers_count", "description": "" }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
" }, { "type": "string", "name": "default_branch", "description": "" }, { "type": "integer", "name": "open_issues_count", "description": "" }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "" }, { "type": "boolean", "name": "has_projects", "description": "" }, { "type": "boolean", "name": "has_wiki", "description": "" }, { "type": "boolean", "name": "has_pages", "description": "" }, { "type": "boolean", "name": "has_downloads", "description": "" }, { "type": "boolean", "name": "has_discussions", "description": "" }, { "type": "boolean", "name": "archived", "description": "" }, { "type": "boolean", "name": "disabled", "description": "" }, { "type": "string", "name": "visibility", "description": "" }, { "type": "string or null", "name": "pushed_at", "description": "" }, { "type": "string or null", "name": "created_at", "description": "" }, { "type": "string or null", "name": "updated_at", "description": "" }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "" }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "push", "description": "" }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "pull", "description": "" } ] }, { "type": "string", "name": "role_name", "description": "" }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "" }, { "type": "integer", "name": "subscribers_count", "description": "" }, { "type": "integer", "name": "network_count", "description": "" }, { "type": "object", "name": "code_of_conduct", "description": "Code Of Conduct
", "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "body", "description": "" }, { "type": "string or null", "name": "html_url", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "license", "description": "", "childParamsGroups": [ { "type": "string", "name": "key", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "spdx_id", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "node_id", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "" }, { "type": "integer", "name": "open_issues", "description": "" }, { "type": "integer", "name": "watchers", "description": "" }, { "type": "boolean", "name": "allow_forking", "description": "" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "" }, { "type": "object or null", "name": "security_and_analysis", "description": "", "childParamsGroups": [ { "type": "object", "name": "advanced_security", "description": "Enable or disable GitHub Advanced Security for the repository.
\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "code_security", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "dependabot_security_updates", "description": "Enable or disable Dependabot security updates for the repository.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "The enablement status of Dependabot security updates for the repository.
", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_push_protection", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_non_provider_patterns", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] } ] }, { "type": "object", "name": "custom_properties", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
" } ] }, { "type": "string", "name": "status", "description": "", "enum": [ "queued", "in_progress", "completed", "pending", "waiting" ] }, { "type": "string", "name": "updated_at", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "waiting", "pending", "startup_failure", "stale", "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ] }, { "type": "object", "name": "deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] }, { "type": "string", "name": "details_url", "description": "", "isRequired": true }, { "type": "string", "name": "external_id", "description": "", "isRequired": true }, { "type": "string", "name": "head_sha", "description": "The SHA of the commit that is being checked.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "The id of the check.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the check.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object", "name": "output", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "annotations_count", "description": "", "isRequired": true }, { "type": "string", "name": "annotations_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "summary", "description": "", "isRequired": true }, { "type": "string or null", "name": "text", "description": "", "isRequired": true }, { "type": "string or null", "name": "title", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] } ] }, { "type": "string", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "The phase of the lifecycle that the check is currently in.
", "isRequired": true, "enum": [ "queued", "in_progress", "completed", "pending" ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
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.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "completed", "category": "check_run" }, "created": { "descriptionHtml": "A new check run was created.
", "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
A check performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "client_id", "description": "" }, { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "Simple User", "description": "A GitHub user.
", "isRequired": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "Enterprise", "description": "An enterprise on GitHub.
", "isRequired": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ], "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "A short description of the enterprise.
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "website_url", "description": "The enterprise's website URL.
" }, { "type": "integer", "name": "id", "description": "Unique identifier of the enterprise
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the enterprise.
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug url identifier for the enterprise.
", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true } ] } ], "oneOfObject": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "external_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "issues", "description": "" }, { "type": "string", "name": "checks", "description": "" }, { "type": "string", "name": "metadata", "description": "" }, { "type": "string", "name": "contents", "description": "" }, { "type": "string", "name": "deployments", "description": "" } ] }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" } ] }, { "type": "object", "name": "check_suite", "description": "A suite of checks performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "after", "description": "" }, { "type": "object or null", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "client_id", "description": "" }, { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "Simple User", "description": "A GitHub user.
", "isRequired": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "Enterprise", "description": "An enterprise on GitHub.
", "isRequired": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ], "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "A short description of the enterprise.
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "website_url", "description": "The enterprise's website URL.
" }, { "type": "integer", "name": "id", "description": "Unique identifier of the enterprise
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the enterprise.
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug url identifier for the enterprise.
", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true } ] } ], "oneOfObject": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "external_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "issues", "description": "" }, { "type": "string", "name": "checks", "description": "" }, { "type": "string", "name": "metadata", "description": "" }, { "type": "string", "name": "contents", "description": "" }, { "type": "string", "name": "deployments", "description": "" } ] }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" } ] }, { "type": "string or null", "name": "before", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", "stale", "startup_failure", null ] }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string or null", "name": "head_branch", "description": "" }, { "type": "string", "name": "head_sha", "description": "The SHA of the head commit that is being checked.
" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "repository", "description": "Minimal Repository
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "" }, { "type": "string or null", "name": "mirror_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "" }, { "type": "string or null", "name": "homepage", "description": "" }, { "type": "string or null", "name": "language", "description": "" }, { "type": "integer", "name": "forks_count", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "" }, { "type": "integer", "name": "watchers_count", "description": "" }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
" }, { "type": "string", "name": "default_branch", "description": "" }, { "type": "integer", "name": "open_issues_count", "description": "" }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "" }, { "type": "boolean", "name": "has_projects", "description": "" }, { "type": "boolean", "name": "has_wiki", "description": "" }, { "type": "boolean", "name": "has_pages", "description": "" }, { "type": "boolean", "name": "has_downloads", "description": "" }, { "type": "boolean", "name": "has_discussions", "description": "" }, { "type": "boolean", "name": "archived", "description": "" }, { "type": "boolean", "name": "disabled", "description": "" }, { "type": "string", "name": "visibility", "description": "" }, { "type": "string or null", "name": "pushed_at", "description": "" }, { "type": "string or null", "name": "created_at", "description": "" }, { "type": "string or null", "name": "updated_at", "description": "" }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "" }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "push", "description": "" }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "pull", "description": "" } ] }, { "type": "string", "name": "role_name", "description": "" }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "" }, { "type": "integer", "name": "subscribers_count", "description": "" }, { "type": "integer", "name": "network_count", "description": "" }, { "type": "object", "name": "code_of_conduct", "description": "Code Of Conduct
", "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "body", "description": "" }, { "type": "string or null", "name": "html_url", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "license", "description": "", "childParamsGroups": [ { "type": "string", "name": "key", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "spdx_id", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "node_id", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "" }, { "type": "integer", "name": "open_issues", "description": "" }, { "type": "integer", "name": "watchers", "description": "" }, { "type": "boolean", "name": "allow_forking", "description": "" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "" }, { "type": "object or null", "name": "security_and_analysis", "description": "", "childParamsGroups": [ { "type": "object", "name": "advanced_security", "description": "Enable or disable GitHub Advanced Security for the repository.
\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "code_security", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "dependabot_security_updates", "description": "Enable or disable Dependabot security updates for the repository.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "The enablement status of Dependabot security updates for the repository.
", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_push_protection", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_non_provider_patterns", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] } ] }, { "type": "object", "name": "custom_properties", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
" } ] }, { "type": "string", "name": "status", "description": "", "enum": [ "queued", "in_progress", "completed", "pending", "waiting" ] }, { "type": "string", "name": "updated_at", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "waiting", "pending", "startup_failure", "stale", "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ] }, { "type": "object", "name": "deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] }, { "type": "string", "name": "details_url", "description": "", "isRequired": true }, { "type": "string", "name": "external_id", "description": "", "isRequired": true }, { "type": "string", "name": "head_sha", "description": "The SHA of the commit that is being checked.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "The id of the check.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the check.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object", "name": "output", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "annotations_count", "description": "", "isRequired": true }, { "type": "string", "name": "annotations_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "summary", "description": "", "isRequired": true }, { "type": "string or null", "name": "text", "description": "", "isRequired": true }, { "type": "string or null", "name": "title", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] } ] }, { "type": "string", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "The phase of the lifecycle that the check is currently in.
", "isRequired": true, "enum": [ "queued", "in_progress", "completed", "pending" ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
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.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "check_run" }, "requested_action": { "descriptionHtml": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
A check performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "client_id", "description": "" }, { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "Simple User", "description": "A GitHub user.
", "isRequired": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "Enterprise", "description": "An enterprise on GitHub.
", "isRequired": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ], "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "A short description of the enterprise.
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "website_url", "description": "The enterprise's website URL.
" }, { "type": "integer", "name": "id", "description": "Unique identifier of the enterprise
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the enterprise.
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug url identifier for the enterprise.
", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true } ] } ], "oneOfObject": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "external_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "issues", "description": "" }, { "type": "string", "name": "checks", "description": "" }, { "type": "string", "name": "metadata", "description": "" }, { "type": "string", "name": "contents", "description": "" }, { "type": "string", "name": "deployments", "description": "" } ] }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" } ] }, { "type": "object", "name": "check_suite", "description": "A suite of checks performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "after", "description": "" }, { "type": "object or null", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "client_id", "description": "" }, { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "Simple User", "description": "A GitHub user.
", "isRequired": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "Enterprise", "description": "An enterprise on GitHub.
", "isRequired": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ], "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "A short description of the enterprise.
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "website_url", "description": "The enterprise's website URL.
" }, { "type": "integer", "name": "id", "description": "Unique identifier of the enterprise
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the enterprise.
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug url identifier for the enterprise.
", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true } ] } ], "oneOfObject": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "external_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "issues", "description": "" }, { "type": "string", "name": "checks", "description": "" }, { "type": "string", "name": "metadata", "description": "" }, { "type": "string", "name": "contents", "description": "" }, { "type": "string", "name": "deployments", "description": "" } ] }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" } ] }, { "type": "string or null", "name": "before", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", "stale", "startup_failure", null ] }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string or null", "name": "head_branch", "description": "" }, { "type": "string", "name": "head_sha", "description": "The SHA of the head commit that is being checked.
" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "repository", "description": "Minimal Repository
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "" }, { "type": "string or null", "name": "mirror_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "" }, { "type": "string or null", "name": "homepage", "description": "" }, { "type": "string or null", "name": "language", "description": "" }, { "type": "integer", "name": "forks_count", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "" }, { "type": "integer", "name": "watchers_count", "description": "" }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
" }, { "type": "string", "name": "default_branch", "description": "" }, { "type": "integer", "name": "open_issues_count", "description": "" }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "" }, { "type": "boolean", "name": "has_projects", "description": "" }, { "type": "boolean", "name": "has_wiki", "description": "" }, { "type": "boolean", "name": "has_pages", "description": "" }, { "type": "boolean", "name": "has_downloads", "description": "" }, { "type": "boolean", "name": "has_discussions", "description": "" }, { "type": "boolean", "name": "archived", "description": "" }, { "type": "boolean", "name": "disabled", "description": "" }, { "type": "string", "name": "visibility", "description": "" }, { "type": "string or null", "name": "pushed_at", "description": "" }, { "type": "string or null", "name": "created_at", "description": "" }, { "type": "string or null", "name": "updated_at", "description": "" }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "" }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "push", "description": "" }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "pull", "description": "" } ] }, { "type": "string", "name": "role_name", "description": "" }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "" }, { "type": "integer", "name": "subscribers_count", "description": "" }, { "type": "integer", "name": "network_count", "description": "" }, { "type": "object", "name": "code_of_conduct", "description": "Code Of Conduct
", "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "body", "description": "" }, { "type": "string or null", "name": "html_url", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "license", "description": "", "childParamsGroups": [ { "type": "string", "name": "key", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "spdx_id", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "node_id", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "" }, { "type": "integer", "name": "open_issues", "description": "" }, { "type": "integer", "name": "watchers", "description": "" }, { "type": "boolean", "name": "allow_forking", "description": "" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "" }, { "type": "object or null", "name": "security_and_analysis", "description": "", "childParamsGroups": [ { "type": "object", "name": "advanced_security", "description": "Enable or disable GitHub Advanced Security for the repository.
\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "code_security", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "dependabot_security_updates", "description": "Enable or disable Dependabot security updates for the repository.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "The enablement status of Dependabot security updates for the repository.
", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_push_protection", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_non_provider_patterns", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] } ] }, { "type": "object", "name": "custom_properties", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
" } ] }, { "type": "string", "name": "status", "description": "", "enum": [ "queued", "in_progress", "completed", "pending", "waiting" ] }, { "type": "string", "name": "updated_at", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "waiting", "pending", "startup_failure", "stale", "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ] }, { "type": "object", "name": "deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] }, { "type": "string", "name": "details_url", "description": "", "isRequired": true }, { "type": "string", "name": "external_id", "description": "", "isRequired": true }, { "type": "string", "name": "head_sha", "description": "The SHA of the commit that is being checked.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "The id of the check.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the check.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object", "name": "output", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "annotations_count", "description": "", "isRequired": true }, { "type": "string", "name": "annotations_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "summary", "description": "", "isRequired": true }, { "type": "string or null", "name": "text", "description": "", "isRequired": true }, { "type": "string or null", "name": "title", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] } ] }, { "type": "string", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "The phase of the lifecycle that the check is currently in.
", "isRequired": true, "enum": [ "queued", "in_progress", "completed", "pending" ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
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.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The action requested by the user.
", "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The integrator reference of the action requested by the user.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "requested_action", "category": "check_run" }, "rerequested": { "descriptionHtml": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
A check performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "client_id", "description": "" }, { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "Simple User", "description": "A GitHub user.
", "isRequired": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "Enterprise", "description": "An enterprise on GitHub.
", "isRequired": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ], "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "A short description of the enterprise.
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "website_url", "description": "The enterprise's website URL.
" }, { "type": "integer", "name": "id", "description": "Unique identifier of the enterprise
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the enterprise.
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug url identifier for the enterprise.
", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true } ] } ], "oneOfObject": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "external_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "issues", "description": "" }, { "type": "string", "name": "checks", "description": "" }, { "type": "string", "name": "metadata", "description": "" }, { "type": "string", "name": "contents", "description": "" }, { "type": "string", "name": "deployments", "description": "" } ] }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" } ] }, { "type": "object", "name": "check_suite", "description": "A suite of checks performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "after", "description": "" }, { "type": "object or null", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "client_id", "description": "" }, { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "Simple User", "description": "A GitHub user.
", "isRequired": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "Enterprise", "description": "An enterprise on GitHub.
", "isRequired": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ], "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "A short description of the enterprise.
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "website_url", "description": "The enterprise's website URL.
" }, { "type": "integer", "name": "id", "description": "Unique identifier of the enterprise
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the enterprise.
", "isRequired": true }, { "type": "string", "name": "slug", "description": "The slug url identifier for the enterprise.
", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true } ] } ], "oneOfObject": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "external_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "issues", "description": "" }, { "type": "string", "name": "checks", "description": "" }, { "type": "string", "name": "metadata", "description": "" }, { "type": "string", "name": "contents", "description": "" }, { "type": "string", "name": "deployments", "description": "" } ] }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" } ] }, { "type": "string or null", "name": "before", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", "stale", "startup_failure", null ] }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string or null", "name": "head_branch", "description": "" }, { "type": "string", "name": "head_sha", "description": "The SHA of the head commit that is being checked.
" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "repository", "description": "Minimal Repository
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "" }, { "type": "string or null", "name": "mirror_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "" }, { "type": "string or null", "name": "homepage", "description": "" }, { "type": "string or null", "name": "language", "description": "" }, { "type": "integer", "name": "forks_count", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "" }, { "type": "integer", "name": "watchers_count", "description": "" }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
" }, { "type": "string", "name": "default_branch", "description": "" }, { "type": "integer", "name": "open_issues_count", "description": "" }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "" }, { "type": "boolean", "name": "has_projects", "description": "" }, { "type": "boolean", "name": "has_wiki", "description": "" }, { "type": "boolean", "name": "has_pages", "description": "" }, { "type": "boolean", "name": "has_downloads", "description": "" }, { "type": "boolean", "name": "has_discussions", "description": "" }, { "type": "boolean", "name": "archived", "description": "" }, { "type": "boolean", "name": "disabled", "description": "" }, { "type": "string", "name": "visibility", "description": "" }, { "type": "string or null", "name": "pushed_at", "description": "" }, { "type": "string or null", "name": "created_at", "description": "" }, { "type": "string or null", "name": "updated_at", "description": "" }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "" }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "push", "description": "" }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "pull", "description": "" } ] }, { "type": "string", "name": "role_name", "description": "" }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "" }, { "type": "integer", "name": "subscribers_count", "description": "" }, { "type": "integer", "name": "network_count", "description": "" }, { "type": "object", "name": "code_of_conduct", "description": "Code Of Conduct
", "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "body", "description": "" }, { "type": "string or null", "name": "html_url", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "license", "description": "", "childParamsGroups": [ { "type": "string", "name": "key", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "spdx_id", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "node_id", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "" }, { "type": "integer", "name": "open_issues", "description": "" }, { "type": "integer", "name": "watchers", "description": "" }, { "type": "boolean", "name": "allow_forking", "description": "" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "" }, { "type": "object or null", "name": "security_and_analysis", "description": "", "childParamsGroups": [ { "type": "object", "name": "advanced_security", "description": "Enable or disable GitHub Advanced Security for the repository.
\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "code_security", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "dependabot_security_updates", "description": "Enable or disable Dependabot security updates for the repository.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "The enablement status of Dependabot security updates for the repository.
", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_push_protection", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_non_provider_patterns", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] } ] }, { "type": "object", "name": "custom_properties", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
" } ] }, { "type": "string", "name": "status", "description": "", "enum": [ "queued", "in_progress", "completed", "pending", "waiting" ] }, { "type": "string", "name": "updated_at", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "waiting", "pending", "startup_failure", "stale", "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ] }, { "type": "object", "name": "deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] }, { "type": "string", "name": "details_url", "description": "", "isRequired": true }, { "type": "string", "name": "external_id", "description": "", "isRequired": true }, { "type": "string", "name": "head_sha", "description": "The SHA of the commit that is being checked.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "The id of the check.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the check.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object", "name": "output", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "annotations_count", "description": "", "isRequired": true }, { "type": "string", "name": "annotations_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "summary", "description": "", "isRequired": true }, { "type": "string or null", "name": "text", "description": "", "isRequired": true }, { "type": "string or null", "name": "title", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] } ] } ] }, { "type": "string", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "The phase of the lifecycle that the check is currently in.
", "isRequired": true, "enum": [ "queued", "in_progress", "completed", "pending" ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
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.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "rerequested", "category": "check_run" } }, "check_suite": { "completed": { "descriptionHtml": "All check runs in a check suite have completed, and a conclusion is available.
", "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
The check_suite.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "after", "description": "", "isRequired": true }, { "type": "object", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, merge_group, pull_request_review_thread, workflow_job, merge_queue_entry, security_and_analysis, projects_v2_item, secret_scanning_alert_location
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "client_id", "description": "The client ID of the GitHub app
" }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "before", "description": "", "isRequired": true }, { "type": "string", "name": "check_runs_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "The summary conclusion for all check runs that are part of the check suite. This value will be null until the check run has completed.
The head branch name the changes are on.
", "isRequired": true }, { "type": "object", "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "author", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "object", "name": "committer", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "string", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "message", "description": "", "isRequired": true }, { "type": "string", "name": "timestamp", "description": "", "isRequired": true }, { "type": "string", "name": "tree_id", "description": "", "isRequired": true } ] }, { "type": "string", "name": "head_sha", "description": "The SHA of the head commit that is being checked.
", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "latest_check_runs_count", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "pull_requests", "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.
The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.
URL that points to the check suite API resource.
", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "completed", "category": "check_suite" }, "requested": { "descriptionHtml": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
The check_suite.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "after", "description": "", "isRequired": true }, { "type": "object", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, workflow_job, merge_queue_entry, security_and_analysis, secret_scanning_alert_location, projects_v2_item, merge_group, repository_import
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "client_id", "description": "Client ID of the GitHub app
" }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "attestations", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "merge_queues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "models", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "before", "description": "", "isRequired": true }, { "type": "string", "name": "check_runs_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "The summary conclusion for all check runs that are part of the check suite. This value will be null until the check run has completed.
The head branch name the changes are on.
", "isRequired": true }, { "type": "object", "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "author", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "object", "name": "committer", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "string", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "message", "description": "", "isRequired": true }, { "type": "string", "name": "timestamp", "description": "", "isRequired": true }, { "type": "string", "name": "tree_id", "description": "", "isRequired": true } ] }, { "type": "string", "name": "head_sha", "description": "The SHA of the head commit that is being checked.
", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "latest_check_runs_count", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "pull_requests", "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.
The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.
URL that points to the check suite API resource.
", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "requested", "category": "check_suite" }, "rerequested": { "descriptionHtml": "Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
The check_suite.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "after", "description": "", "isRequired": true }, { "type": "object", "name": "app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, merge_queue_entry, workflow_job
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string or null", "name": "client_id", "description": "The Client ID for the GitHub app
" }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "attestations", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "merge_queues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "models", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "before", "description": "", "isRequired": true }, { "type": "string", "name": "check_runs_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "The summary conclusion for all check runs that are part of the check suite. This value will be null until the check run has completed.
The head branch name the changes are on.
", "isRequired": true }, { "type": "object", "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "author", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "object", "name": "committer", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "string", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "message", "description": "", "isRequired": true }, { "type": "string", "name": "timestamp", "description": "", "isRequired": true }, { "type": "string", "name": "tree_id", "description": "", "isRequired": true } ] }, { "type": "string", "name": "head_sha", "description": "The SHA of the head commit that is being checked.
", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "latest_check_runs_count", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "pull_requests", "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.
The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.
URL that points to the check suite API resource.
", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "rerequested", "category": "check_suite" } }, "code_scanning_alert": { "appeared_in_branch": { "descriptionHtml": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.
", "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "appeared_in_branch" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason for dismissing or closing the alert.
", "isRequired": true, "enum": [ "false positive", "won't fix", "used in tests", null ] }, { "type": "null", "name": "fixed_at", "description": "The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "object or null", "name": "most_recent_instance", "description": "", "childParamsGroups": [ { "type": "string", "name": "analysis_key", "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", "isRequired": true }, { "type": "string", "name": "category", "description": "Identifies the configuration under which the analysis was executed.
" }, { "type": "array of strings", "name": "classifications", "description": "" }, { "type": "string", "name": "commit_sha", "description": "" }, { "type": "string", "name": "environment", "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", "isRequired": true }, { "type": "object", "name": "location", "description": "", "childParamsGroups": [ { "type": "integer", "name": "end_column", "description": "" }, { "type": "integer", "name": "end_line", "description": "" }, { "type": "string", "name": "path", "description": "" }, { "type": "integer", "name": "start_column", "description": "" }, { "type": "integer", "name": "start_line", "description": "" } ] }, { "type": "object", "name": "message", "description": "", "childParamsGroups": [ { "type": "string", "name": "text", "description": "" } ] }, { "type": "string", "name": "ref", "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", "isRequired": true, "enum": [ "open", "dismissed", "fixed" ] } ] }, { "type": "integer", "name": "number", "description": "The code scanning alert number.
", "isRequired": true }, { "type": "object", "name": "rule", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "description", "description": "A short description of the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "id", "description": "A unique identifier for the rule used to detect the alert.
", "isRequired": true }, { "type": "string or null", "name": "severity", "description": "The severity of the alert.
", "isRequired": true, "enum": [ "none", "note", "warning", "error", null ] } ] }, { "type": "string or null", "name": "state", "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", "isRequired": true }, { "type": "string or null", "name": "version", "description": "The version of the tool used to detect the alert.
", "isRequired": true } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "commit_oid", "in": "body", "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "appeared_in_branch", "category": "code_scanning_alert" }, "closed_by_user": { "descriptionHtml": "Someone closed a code scanning alert.
", "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "closed_by_user" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason for dismissing or closing the alert.
", "isRequired": true, "enum": [ "false positive", "won't fix", "used in tests", null ] }, { "type": "null", "name": "fixed_at", "description": "The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "object or null", "name": "most_recent_instance", "description": "", "childParamsGroups": [ { "type": "string", "name": "analysis_key", "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", "isRequired": true }, { "type": "string", "name": "category", "description": "Identifies the configuration under which the analysis was executed.
" }, { "type": "array of strings", "name": "classifications", "description": "" }, { "type": "string", "name": "commit_sha", "description": "" }, { "type": "string", "name": "environment", "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", "isRequired": true }, { "type": "object", "name": "location", "description": "", "childParamsGroups": [ { "type": "integer", "name": "end_column", "description": "" }, { "type": "integer", "name": "end_line", "description": "" }, { "type": "string", "name": "path", "description": "" }, { "type": "integer", "name": "start_column", "description": "" }, { "type": "integer", "name": "start_line", "description": "" } ] }, { "type": "object", "name": "message", "description": "", "childParamsGroups": [ { "type": "string", "name": "text", "description": "" } ] }, { "type": "string", "name": "ref", "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", "isRequired": true, "enum": [ "open", "dismissed", "fixed" ] } ] }, { "type": "integer", "name": "number", "description": "The code scanning alert number.
", "isRequired": true }, { "type": "object", "name": "rule", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "description", "description": "A short description of the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "full_description", "description": "" }, { "type": "string or null", "name": "help", "description": "" }, { "type": "string or null", "name": "help_uri", "description": "A link to the documentation for the rule used to detect the alert.
" }, { "type": "string", "name": "id", "description": "A unique identifier for the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string or null", "name": "severity", "description": "The severity of the alert.
", "isRequired": true, "enum": [ "none", "note", "warning", "error", null ] }, { "type": "array of strings or null", "name": "tags", "description": "" } ] }, { "type": "string", "name": "state", "description": "State of a code scanning alert.
", "isRequired": true, "enum": [ "dismissed", "fixed" ] }, { "type": "object", "name": "tool", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "guid", "description": "" }, { "type": "string", "name": "name", "description": "The name of the tool used to generate the code scanning analysis alert.
", "isRequired": true }, { "type": "string or null", "name": "version", "description": "The version of the tool used to detect the alert.
", "isRequired": true } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "dismissal_approved_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "commit_oid", "in": "body", "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "closed_by_user", "category": "code_scanning_alert" }, "created": { "descriptionHtml": "A code scanning alert was created in a repository.
", "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" }, { "type": "null", "name": "dismissed_reason", "description": "The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "instances_url", "description": "" }, { "type": "object or null", "name": "most_recent_instance", "description": "", "childParamsGroups": [ { "type": "string", "name": "analysis_key", "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", "isRequired": true }, { "type": "string", "name": "category", "description": "Identifies the configuration under which the analysis was executed.
" }, { "type": "array of strings", "name": "classifications", "description": "" }, { "type": "string", "name": "commit_sha", "description": "" }, { "type": "string", "name": "environment", "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", "isRequired": true }, { "type": "object", "name": "location", "description": "", "childParamsGroups": [ { "type": "integer", "name": "end_column", "description": "" }, { "type": "integer", "name": "end_line", "description": "" }, { "type": "string", "name": "path", "description": "" }, { "type": "integer", "name": "start_column", "description": "" }, { "type": "integer", "name": "start_line", "description": "" } ] }, { "type": "object", "name": "message", "description": "", "childParamsGroups": [ { "type": "string", "name": "text", "description": "" } ] }, { "type": "string", "name": "ref", "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", "isRequired": true, "enum": [ "open", "dismissed", "fixed" ] } ] }, { "type": "integer", "name": "number", "description": "The code scanning alert number.
", "isRequired": true }, { "type": "object", "name": "rule", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "description", "description": "A short description of the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "full_description", "description": "" }, { "type": "string or null", "name": "help", "description": "" }, { "type": "string or null", "name": "help_uri", "description": "A link to the documentation for the rule used to detect the alert.
" }, { "type": "string", "name": "id", "description": "A unique identifier for the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string or null", "name": "severity", "description": "The severity of the alert.
", "isRequired": true, "enum": [ "none", "note", "warning", "error", null ] }, { "type": "array of strings or null", "name": "tags", "description": "" } ] }, { "type": "string or null", "name": "state", "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", "isRequired": true }, { "type": "string or null", "name": "version", "description": "The version of the tool used to detect the alert.
", "isRequired": true } ] }, { "type": "string or null", "name": "updated_at", "description": "" }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "null", "name": "dismissal_approved_by", "description": "" }, { "type": "array of objects", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "commit_oid", "in": "body", "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "code_scanning_alert" }, "fixed": { "descriptionHtml": "A code scanning alert was fixed in a branch by a commit.
", "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "fixed" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason for dismissing or closing the alert.
", "isRequired": true, "enum": [ "false positive", "won't fix", "used in tests", null ] }, { "type": "null", "name": "fixed_at", "description": "The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "instances_url", "description": "" }, { "type": "object or null", "name": "most_recent_instance", "description": "", "childParamsGroups": [ { "type": "string", "name": "analysis_key", "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", "isRequired": true }, { "type": "string", "name": "category", "description": "Identifies the configuration under which the analysis was executed.
" }, { "type": "array of strings", "name": "classifications", "description": "" }, { "type": "string", "name": "commit_sha", "description": "" }, { "type": "string", "name": "environment", "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", "isRequired": true }, { "type": "object", "name": "location", "description": "", "childParamsGroups": [ { "type": "integer", "name": "end_column", "description": "" }, { "type": "integer", "name": "end_line", "description": "" }, { "type": "string", "name": "path", "description": "" }, { "type": "integer", "name": "start_column", "description": "" }, { "type": "integer", "name": "start_line", "description": "" } ] }, { "type": "object", "name": "message", "description": "", "childParamsGroups": [ { "type": "string", "name": "text", "description": "" } ] }, { "type": "string", "name": "ref", "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", "isRequired": true, "enum": [ "open", "dismissed", "fixed" ] } ] }, { "type": "integer", "name": "number", "description": "The code scanning alert number.
", "isRequired": true }, { "type": "object", "name": "rule", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "description", "description": "A short description of the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "full_description", "description": "" }, { "type": "string or null", "name": "help", "description": "" }, { "type": "string or null", "name": "help_uri", "description": "A link to the documentation for the rule used to detect the alert.
" }, { "type": "string", "name": "id", "description": "A unique identifier for the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string or null", "name": "severity", "description": "The severity of the alert.
", "isRequired": true, "enum": [ "none", "note", "warning", "error", null ] }, { "type": "array of strings or null", "name": "tags", "description": "" } ] }, { "type": "string or null", "name": "state", "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", "isRequired": true }, { "type": "string or null", "name": "version", "description": "The version of the tool used to detect the alert.
", "isRequired": true } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "commit_oid", "in": "body", "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "fixed", "category": "code_scanning_alert" }, "reopened": { "descriptionHtml": "A previously fixed code scanning alert reappeared in a branch.
", "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "reopened" ], "childParamsGroups": [] }, { "type": "object or null", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "object or null", "name": "most_recent_instance", "description": "", "childParamsGroups": [ { "type": "string", "name": "analysis_key", "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", "isRequired": true }, { "type": "string", "name": "category", "description": "Identifies the configuration under which the analysis was executed.
" }, { "type": "array of strings", "name": "classifications", "description": "" }, { "type": "string", "name": "commit_sha", "description": "" }, { "type": "string", "name": "environment", "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", "isRequired": true }, { "type": "object", "name": "location", "description": "", "childParamsGroups": [ { "type": "integer", "name": "end_column", "description": "" }, { "type": "integer", "name": "end_line", "description": "" }, { "type": "string", "name": "path", "description": "" }, { "type": "integer", "name": "start_column", "description": "" }, { "type": "integer", "name": "start_line", "description": "" } ] }, { "type": "object", "name": "message", "description": "", "childParamsGroups": [ { "type": "string", "name": "text", "description": "" } ] }, { "type": "string", "name": "ref", "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", "isRequired": true, "enum": [ "open", "dismissed", "fixed" ] } ] }, { "type": "integer", "name": "number", "description": "The code scanning alert number.
", "isRequired": true }, { "type": "object", "name": "rule", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "description", "description": "A short description of the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "full_description", "description": "" }, { "type": "string or null", "name": "help", "description": "" }, { "type": "string or null", "name": "help_uri", "description": "A link to the documentation for the rule used to detect the alert.
" }, { "type": "string", "name": "id", "description": "A unique identifier for the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string or null", "name": "severity", "description": "The severity of the alert.
", "isRequired": true, "enum": [ "none", "note", "warning", "error", null ] }, { "type": "array of strings or null", "name": "tags", "description": "" } ] }, { "type": "string or null", "name": "state", "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", "isRequired": true }, { "type": "string or null", "name": "version", "description": "The version of the tool used to detect the alert.
", "isRequired": true } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "commit_oid", "in": "body", "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reopened", "category": "code_scanning_alert" }, "reopened_by_user": { "descriptionHtml": "Someone reopened a code scanning alert.
", "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "reopened_by_user" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" }, { "type": "null", "name": "dismissed_reason", "description": "The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "object or null", "name": "most_recent_instance", "description": "", "childParamsGroups": [ { "type": "string", "name": "analysis_key", "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", "isRequired": true }, { "type": "string", "name": "category", "description": "Identifies the configuration under which the analysis was executed.
" }, { "type": "array of strings", "name": "classifications", "description": "" }, { "type": "string", "name": "commit_sha", "description": "" }, { "type": "string", "name": "environment", "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", "isRequired": true }, { "type": "object", "name": "location", "description": "", "childParamsGroups": [ { "type": "integer", "name": "end_column", "description": "" }, { "type": "integer", "name": "end_line", "description": "" }, { "type": "string", "name": "path", "description": "" }, { "type": "integer", "name": "start_column", "description": "" }, { "type": "integer", "name": "start_line", "description": "" } ] }, { "type": "object", "name": "message", "description": "", "childParamsGroups": [ { "type": "string", "name": "text", "description": "" } ] }, { "type": "string", "name": "ref", "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", "isRequired": true, "enum": [ "open", "dismissed", "fixed" ] } ] }, { "type": "integer", "name": "number", "description": "The code scanning alert number.
", "isRequired": true }, { "type": "object", "name": "rule", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "description", "description": "A short description of the rule used to detect the alert.
", "isRequired": true }, { "type": "string", "name": "id", "description": "A unique identifier for the rule used to detect the alert.
", "isRequired": true }, { "type": "string or null", "name": "severity", "description": "The severity of the alert.
", "isRequired": true, "enum": [ "none", "note", "warning", "error", null ] } ] }, { "type": "string or null", "name": "state", "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", "isRequired": true }, { "type": "string or null", "name": "version", "description": "The version of the tool used to detect the alert.
", "isRequired": true } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "commit_oid", "in": "body", "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reopened_by_user", "category": "code_scanning_alert" } }, "commit_comment": { "created": { "descriptionHtml": "Someone commented on a commit.
", "summaryHtml": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.
\nFor activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "The action performed. Can be created.
The commit comment resource.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "commit_comment" } }, "create": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when a Git branch or tag is created.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\nNotes:
\nThe repository's current description.
", "isRequired": true }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The name of the repository's default branch (usually main).
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The pusher type for the event. Can be either user or a deploy key.
The git ref resource.
The type of Git ref object created in the repository.
", "isRequired": true, "enum": [ "tag", "branch" ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "create" } }, "custom_property": { "created": { "descriptionHtml": "A new custom property was created.
", "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "definition", "in": "body", "description": "Custom property defined on an organization
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "property_name", "description": "The name of the property
", "isRequired": true }, { "type": "string", "name": "url", "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" }, { "type": "string", "name": "source_type", "description": "The source type of the property
", "enum": [ "organization", "enterprise" ] }, { "type": "string", "name": "value_type", "description": "The type of the value for the property
", "isRequired": true, "enum": [ "string", "single_select", "multi_select", "true_false" ] }, { "type": "boolean", "name": "required", "description": "Whether the property is required.
" }, { "type": "null or string or array", "name": "default_value", "description": "Default value of the property
" }, { "type": "string or null", "name": "description", "description": "Short description of the property
" }, { "type": "array of strings or null", "name": "allowed_values", "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" }, { "type": "string or null", "name": "values_editable_by", "description": "Who can edit the values of the property
", "enum": [ "org_actors", "org_and_repo_actors", null ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "business", "organization", "app" ], "action": "created", "category": "custom_property" }, "deleted": { "descriptionHtml": "A custom property was deleted.
", "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "definition", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "property_name", "description": "The name of the property that was deleted.
", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "business", "organization", "app" ], "action": "deleted", "category": "custom_property" }, "promote_to_enterprise": { "descriptionHtml": "A custom property was promoted to an enterprise.
", "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "promote_to_enterprise" ], "childParamsGroups": [] }, { "type": "object", "name": "definition", "in": "body", "description": "Custom property defined on an organization
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "property_name", "description": "The name of the property
", "isRequired": true }, { "type": "string", "name": "url", "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" }, { "type": "string", "name": "source_type", "description": "The source type of the property
", "enum": [ "organization", "enterprise" ] }, { "type": "string", "name": "value_type", "description": "The type of the value for the property
", "isRequired": true, "enum": [ "string", "single_select", "multi_select", "true_false" ] }, { "type": "boolean", "name": "required", "description": "Whether the property is required.
" }, { "type": "null or string or array", "name": "default_value", "description": "Default value of the property
" }, { "type": "string or null", "name": "description", "description": "Short description of the property
" }, { "type": "array of strings or null", "name": "allowed_values", "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" }, { "type": "string or null", "name": "values_editable_by", "description": "Who can edit the values of the property
", "enum": [ "org_actors", "org_and_repo_actors", null ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "business", "organization", "app" ], "action": "promote_to_enterprise", "category": "custom_property" }, "updated": { "descriptionHtml": "A custom property was updated.
", "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "updated" ], "childParamsGroups": [] }, { "type": "object", "name": "definition", "in": "body", "description": "Custom property defined on an organization
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "property_name", "description": "The name of the property
", "isRequired": true }, { "type": "string", "name": "url", "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" }, { "type": "string", "name": "source_type", "description": "The source type of the property
", "enum": [ "organization", "enterprise" ] }, { "type": "string", "name": "value_type", "description": "The type of the value for the property
", "isRequired": true, "enum": [ "string", "single_select", "multi_select", "true_false" ] }, { "type": "boolean", "name": "required", "description": "Whether the property is required.
" }, { "type": "null or string or array", "name": "default_value", "description": "Default value of the property
" }, { "type": "string or null", "name": "description", "description": "Short description of the property
" }, { "type": "array of strings or null", "name": "allowed_values", "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" }, { "type": "string or null", "name": "values_editable_by", "description": "Who can edit the values of the property
", "enum": [ "org_actors", "org_and_repo_actors", null ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "business", "organization", "app" ], "action": "updated", "category": "custom_property" } }, "custom_property_values": { "updated": { "descriptionHtml": "The custom property values of a repository were updated.
", "summaryHtml": "This event occurs when there is activity relating to custom property values for a repository.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties for a repository, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "updated" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "childParamsGroups": [] }, { "type": "array of objects", "name": "new_property_values", "in": "body", "description": "The new custom property values for the repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "property_name", "description": "The name of the property
", "isRequired": true }, { "type": "null or string or array", "name": "value", "description": "The value assigned to the property
", "isRequired": true } ] }, { "type": "array of objects", "name": "old_property_values", "in": "body", "description": "The old custom property values for the repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "property_name", "description": "The name of the property
", "isRequired": true }, { "type": "null or string or array", "name": "value", "description": "The value assigned to the property
", "isRequired": true } ] } ], "availability": [ "repository", "organization", "app" ], "action": "updated", "category": "custom_property_values" } }, "delete": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nAn 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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The pusher type for the event. Can be either user or a deploy key.
The git ref resource.
The type of Git ref object deleted in the repository.
", "isRequired": true, "enum": [ "tag", "branch" ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "delete" } }, "dependabot_alert": { "auto_dismissed": { "descriptionHtml": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.
", "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the Dependabot alert.
", "isRequired": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, { "type": "object", "name": "dependency", "description": "Details for the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "manifest_path", "description": "The full path to the dependency manifest file, relative to the root of the repository.
" }, { "type": "string or null", "name": "scope", "description": "The execution scope of the vulnerable dependency.
", "enum": [ "development", "runtime", null ] } ] }, { "type": "object", "name": "security_advisory", "description": "Details for the GitHub Security Advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ghsa_id", "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", "isRequired": true }, { "type": "string or null", "name": "cve_id", "description": "The unique CVE ID assigned to the advisory.
", "isRequired": true }, { "type": "string", "name": "summary", "description": "A short, plain text summary of the advisory.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A long-form Markdown-supported description of the advisory.
", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "Vulnerable version range information for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "severity", "description": "The severity of the advisory.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "object", "name": "cvss", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "The overall CVSS score of the advisory.
", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "The full CVSS vector string for the advisory.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "object or null", "name": "epss", "description": "The EPSS scores as calculated by the Exploit Prediction Scoring System.
", "childParamsGroups": [ { "type": "number", "name": "percentage", "description": "" }, { "type": "number", "name": "percentile", "description": "" } ] }, { "type": "array of objects", "name": "cwes", "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "The unique CWE ID.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The short, plain text name of the CWE.
", "isRequired": true } ] }, { "type": "array of objects", "name": "identifiers", "description": "Values that identify this advisory among security information sources.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of advisory identifier.
", "isRequired": true, "enum": [ "CVE", "GHSA" ] }, { "type": "string", "name": "value", "description": "The value of the advisory identifer.
", "isRequired": true } ] }, { "type": "array of objects", "name": "references", "description": "Links to additional advisory information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL of the reference.
", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "url", "description": "The REST API URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason that the alert was dismissed.
", "isRequired": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk", null ] }, { "type": "string or null", "name": "dismissed_comment", "description": "An optional comment associated with the alert's dismissal.
", "isRequired": true }, { "type": "string or null", "name": "fixed_at", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "auto_dismissed", "category": "dependabot_alert" }, "auto_reopened": { "descriptionHtml": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.
", "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the Dependabot alert.
", "isRequired": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, { "type": "object", "name": "dependency", "description": "Details for the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "manifest_path", "description": "The full path to the dependency manifest file, relative to the root of the repository.
" }, { "type": "string or null", "name": "scope", "description": "The execution scope of the vulnerable dependency.
", "enum": [ "development", "runtime", null ] } ] }, { "type": "object", "name": "security_advisory", "description": "Details for the GitHub Security Advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ghsa_id", "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", "isRequired": true }, { "type": "string or null", "name": "cve_id", "description": "The unique CVE ID assigned to the advisory.
", "isRequired": true }, { "type": "string", "name": "summary", "description": "A short, plain text summary of the advisory.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A long-form Markdown-supported description of the advisory.
", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "Vulnerable version range information for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "severity", "description": "The severity of the advisory.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "object", "name": "cvss", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "The overall CVSS score of the advisory.
", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "The full CVSS vector string for the advisory.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "object or null", "name": "epss", "description": "The EPSS scores as calculated by the Exploit Prediction Scoring System.
", "childParamsGroups": [ { "type": "number", "name": "percentage", "description": "" }, { "type": "number", "name": "percentile", "description": "" } ] }, { "type": "array of objects", "name": "cwes", "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "The unique CWE ID.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The short, plain text name of the CWE.
", "isRequired": true } ] }, { "type": "array of objects", "name": "identifiers", "description": "Values that identify this advisory among security information sources.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of advisory identifier.
", "isRequired": true, "enum": [ "CVE", "GHSA" ] }, { "type": "string", "name": "value", "description": "The value of the advisory identifer.
", "isRequired": true } ] }, { "type": "array of objects", "name": "references", "description": "Links to additional advisory information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL of the reference.
", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "url", "description": "The REST API URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason that the alert was dismissed.
", "isRequired": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk", null ] }, { "type": "string or null", "name": "dismissed_comment", "description": "An optional comment associated with the alert's dismissal.
", "isRequired": true }, { "type": "string or null", "name": "fixed_at", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "auto_reopened", "category": "dependabot_alert" }, "created": { "descriptionHtml": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the Dependabot alert.
", "isRequired": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, { "type": "object", "name": "dependency", "description": "Details for the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "manifest_path", "description": "The full path to the dependency manifest file, relative to the root of the repository.
" }, { "type": "string or null", "name": "scope", "description": "The execution scope of the vulnerable dependency.
", "enum": [ "development", "runtime", null ] } ] }, { "type": "object", "name": "security_advisory", "description": "Details for the GitHub Security Advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ghsa_id", "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", "isRequired": true }, { "type": "string or null", "name": "cve_id", "description": "The unique CVE ID assigned to the advisory.
", "isRequired": true }, { "type": "string", "name": "summary", "description": "A short, plain text summary of the advisory.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A long-form Markdown-supported description of the advisory.
", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "Vulnerable version range information for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "severity", "description": "The severity of the advisory.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "object", "name": "cvss", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "The overall CVSS score of the advisory.
", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "The full CVSS vector string for the advisory.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "object or null", "name": "epss", "description": "The EPSS scores as calculated by the Exploit Prediction Scoring System.
", "childParamsGroups": [ { "type": "number", "name": "percentage", "description": "" }, { "type": "number", "name": "percentile", "description": "" } ] }, { "type": "array of objects", "name": "cwes", "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "The unique CWE ID.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The short, plain text name of the CWE.
", "isRequired": true } ] }, { "type": "array of objects", "name": "identifiers", "description": "Values that identify this advisory among security information sources.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of advisory identifier.
", "isRequired": true, "enum": [ "CVE", "GHSA" ] }, { "type": "string", "name": "value", "description": "The value of the advisory identifer.
", "isRequired": true } ] }, { "type": "array of objects", "name": "references", "description": "Links to additional advisory information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL of the reference.
", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "url", "description": "The REST API URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason that the alert was dismissed.
", "isRequired": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk", null ] }, { "type": "string or null", "name": "dismissed_comment", "description": "An optional comment associated with the alert's dismissal.
", "isRequired": true }, { "type": "string or null", "name": "fixed_at", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "dependabot_alert" }, "dismissed": { "descriptionHtml": "A Dependabot alert was manually closed.
", "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the Dependabot alert.
", "isRequired": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, { "type": "object", "name": "dependency", "description": "Details for the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "manifest_path", "description": "The full path to the dependency manifest file, relative to the root of the repository.
" }, { "type": "string or null", "name": "scope", "description": "The execution scope of the vulnerable dependency.
", "enum": [ "development", "runtime", null ] } ] }, { "type": "object", "name": "security_advisory", "description": "Details for the GitHub Security Advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ghsa_id", "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", "isRequired": true }, { "type": "string or null", "name": "cve_id", "description": "The unique CVE ID assigned to the advisory.
", "isRequired": true }, { "type": "string", "name": "summary", "description": "A short, plain text summary of the advisory.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A long-form Markdown-supported description of the advisory.
", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "Vulnerable version range information for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "severity", "description": "The severity of the advisory.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "object", "name": "cvss", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "The overall CVSS score of the advisory.
", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "The full CVSS vector string for the advisory.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "object or null", "name": "epss", "description": "The EPSS scores as calculated by the Exploit Prediction Scoring System.
", "childParamsGroups": [ { "type": "number", "name": "percentage", "description": "" }, { "type": "number", "name": "percentile", "description": "" } ] }, { "type": "array of objects", "name": "cwes", "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "The unique CWE ID.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The short, plain text name of the CWE.
", "isRequired": true } ] }, { "type": "array of objects", "name": "identifiers", "description": "Values that identify this advisory among security information sources.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of advisory identifier.
", "isRequired": true, "enum": [ "CVE", "GHSA" ] }, { "type": "string", "name": "value", "description": "The value of the advisory identifer.
", "isRequired": true } ] }, { "type": "array of objects", "name": "references", "description": "Links to additional advisory information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL of the reference.
", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "url", "description": "The REST API URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason that the alert was dismissed.
", "isRequired": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk", null ] }, { "type": "string or null", "name": "dismissed_comment", "description": "An optional comment associated with the alert's dismissal.
", "isRequired": true }, { "type": "string or null", "name": "fixed_at", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "dismissed", "category": "dependabot_alert" }, "fixed": { "descriptionHtml": "A manifest file change removed a vulnerability.
", "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the Dependabot alert.
", "isRequired": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, { "type": "object", "name": "dependency", "description": "Details for the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "manifest_path", "description": "The full path to the dependency manifest file, relative to the root of the repository.
" }, { "type": "string or null", "name": "scope", "description": "The execution scope of the vulnerable dependency.
", "enum": [ "development", "runtime", null ] } ] }, { "type": "object", "name": "security_advisory", "description": "Details for the GitHub Security Advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ghsa_id", "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", "isRequired": true }, { "type": "string or null", "name": "cve_id", "description": "The unique CVE ID assigned to the advisory.
", "isRequired": true }, { "type": "string", "name": "summary", "description": "A short, plain text summary of the advisory.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A long-form Markdown-supported description of the advisory.
", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "Vulnerable version range information for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "severity", "description": "The severity of the advisory.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "object", "name": "cvss", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "The overall CVSS score of the advisory.
", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "The full CVSS vector string for the advisory.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "object or null", "name": "epss", "description": "The EPSS scores as calculated by the Exploit Prediction Scoring System.
", "childParamsGroups": [ { "type": "number", "name": "percentage", "description": "" }, { "type": "number", "name": "percentile", "description": "" } ] }, { "type": "array of objects", "name": "cwes", "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "The unique CWE ID.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The short, plain text name of the CWE.
", "isRequired": true } ] }, { "type": "array of objects", "name": "identifiers", "description": "Values that identify this advisory among security information sources.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of advisory identifier.
", "isRequired": true, "enum": [ "CVE", "GHSA" ] }, { "type": "string", "name": "value", "description": "The value of the advisory identifer.
", "isRequired": true } ] }, { "type": "array of objects", "name": "references", "description": "Links to additional advisory information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL of the reference.
", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "url", "description": "The REST API URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason that the alert was dismissed.
", "isRequired": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk", null ] }, { "type": "string or null", "name": "dismissed_comment", "description": "An optional comment associated with the alert's dismissal.
", "isRequired": true }, { "type": "string or null", "name": "fixed_at", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "fixed", "category": "dependabot_alert" }, "reintroduced": { "descriptionHtml": "A manifest file change introduced a vulnerable dependency that had previously been fixed.
", "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the Dependabot alert.
", "isRequired": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, { "type": "object", "name": "dependency", "description": "Details for the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "manifest_path", "description": "The full path to the dependency manifest file, relative to the root of the repository.
" }, { "type": "string or null", "name": "scope", "description": "The execution scope of the vulnerable dependency.
", "enum": [ "development", "runtime", null ] } ] }, { "type": "object", "name": "security_advisory", "description": "Details for the GitHub Security Advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ghsa_id", "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", "isRequired": true }, { "type": "string or null", "name": "cve_id", "description": "The unique CVE ID assigned to the advisory.
", "isRequired": true }, { "type": "string", "name": "summary", "description": "A short, plain text summary of the advisory.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A long-form Markdown-supported description of the advisory.
", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "Vulnerable version range information for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "severity", "description": "The severity of the advisory.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "object", "name": "cvss", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "The overall CVSS score of the advisory.
", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "The full CVSS vector string for the advisory.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "object or null", "name": "epss", "description": "The EPSS scores as calculated by the Exploit Prediction Scoring System.
", "childParamsGroups": [ { "type": "number", "name": "percentage", "description": "" }, { "type": "number", "name": "percentile", "description": "" } ] }, { "type": "array of objects", "name": "cwes", "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "The unique CWE ID.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The short, plain text name of the CWE.
", "isRequired": true } ] }, { "type": "array of objects", "name": "identifiers", "description": "Values that identify this advisory among security information sources.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of advisory identifier.
", "isRequired": true, "enum": [ "CVE", "GHSA" ] }, { "type": "string", "name": "value", "description": "The value of the advisory identifer.
", "isRequired": true } ] }, { "type": "array of objects", "name": "references", "description": "Links to additional advisory information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL of the reference.
", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "url", "description": "The REST API URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason that the alert was dismissed.
", "isRequired": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk", null ] }, { "type": "string or null", "name": "dismissed_comment", "description": "An optional comment associated with the alert's dismissal.
", "isRequired": true }, { "type": "string or null", "name": "fixed_at", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reintroduced", "category": "dependabot_alert" }, "reopened": { "descriptionHtml": "A Dependabot alert was manually reopened.
", "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the Dependabot alert.
", "isRequired": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, { "type": "object", "name": "dependency", "description": "Details for the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "manifest_path", "description": "The full path to the dependency manifest file, relative to the root of the repository.
" }, { "type": "string or null", "name": "scope", "description": "The execution scope of the vulnerable dependency.
", "enum": [ "development", "runtime", null ] } ] }, { "type": "object", "name": "security_advisory", "description": "Details for the GitHub Security Advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ghsa_id", "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", "isRequired": true }, { "type": "string or null", "name": "cve_id", "description": "The unique CVE ID assigned to the advisory.
", "isRequired": true }, { "type": "string", "name": "summary", "description": "A short, plain text summary of the advisory.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A long-form Markdown-supported description of the advisory.
", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "Vulnerable version range information for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "severity", "description": "The severity of the advisory.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "object", "name": "cvss", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "The overall CVSS score of the advisory.
", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "The full CVSS vector string for the advisory.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "object or null", "name": "epss", "description": "The EPSS scores as calculated by the Exploit Prediction Scoring System.
", "childParamsGroups": [ { "type": "number", "name": "percentage", "description": "" }, { "type": "number", "name": "percentile", "description": "" } ] }, { "type": "array of objects", "name": "cwes", "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "The unique CWE ID.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The short, plain text name of the CWE.
", "isRequired": true } ] }, { "type": "array of objects", "name": "identifiers", "description": "Values that identify this advisory among security information sources.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of advisory identifier.
", "isRequired": true, "enum": [ "CVE", "GHSA" ] }, { "type": "string", "name": "value", "description": "The value of the advisory identifer.
", "isRequired": true } ] }, { "type": "array of objects", "name": "references", "description": "Links to additional advisory information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL of the reference.
", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "package", "description": "Details for the vulnerable package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "The package's language or package management ecosystem.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The unique package name within its ecosystem.
", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "The severity of the vulnerability.
", "isRequired": true, "enum": [ "low", "medium", "high", "critical" ] }, { "type": "string", "name": "vulnerable_version_range", "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", "isRequired": true }, { "type": "object or null", "name": "first_patched_version", "description": "Details pertaining to the package version that patches this vulnerability.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "The package version that patches this vulnerability.
", "isRequired": true } ] } ] }, { "type": "string", "name": "url", "description": "The REST API URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "dismissed_reason", "description": "The reason that the alert was dismissed.
", "isRequired": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk", null ] }, { "type": "string or null", "name": "dismissed_comment", "description": "An optional comment associated with the alert's dismissal.
", "isRequired": true }, { "type": "string or null", "name": "fixed_at", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reopened", "category": "dependabot_alert" } }, "deploy_key": { "created": { "descriptionHtml": "A deploy key was created.
", "summaryHtml": "This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The deploy key resource.
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "deploy_key" }, "deleted": { "descriptionHtml": "A deploy key was deleted.
", "summaryHtml": "This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The deploy key resource.
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "deploy_key" } }, "deployment": { "created": { "descriptionHtml": "A deployment was created.
", "summaryHtml": "This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment status, use the deployment_status event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "deployment", "in": "body", "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "environment", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "", "isRequired": true }, { "type": "object or string", "name": "payload", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, workflow_job, pull_request_review_thread, merge_queue_entry, secret_scanning_alert_location, merge_group
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "boolean", "name": "production_environment", "description": "" }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "task", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "" }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object or null", "name": "workflow", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "badge_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "workflow_run", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "artifacts_url", "description": "" }, { "type": "string", "name": "cancel_url", "description": "" }, { "type": "integer", "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_url", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "display_title", "description": "", "isRequired": true }, { "type": "string", "name": "event", "description": "", "isRequired": true }, { "type": "string", "name": "head_branch", "description": "", "isRequired": true }, { "type": "null", "name": "head_commit", "description": "" }, { "type": "object", "name": "head_repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "jobs_url", "description": "" }, { "type": "string", "name": "logs_url", "description": "" }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "null", "name": "previous_attempt_url", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "array of objects or null", "name": "referenced_workflows", "description": "", "childParamsGroups": [ { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "" }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "rerun_url", "description": "" }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "integer", "name": "run_number", "description": "", "isRequired": true }, { "type": "string", "name": "run_started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "requested", "in_progress", "completed", "queued", "waiting", "pending" ] }, { "type": "object or null", "name": "triggering_actor", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", "name": "workflow_url", "description": "" } ] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "deployment" } }, "deployment_protection_rule": { "requested": { "descriptionHtml": "A deployment protection rule was requested for an environment.
", "summaryHtml": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"Using environments for deployment.\" For information about the API to manage deployment protection rules, see the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "enum": [ "requested" ], "childParamsGroups": [] }, { "type": "string", "name": "environment", "in": "body", "description": "The name of the environment that has the deployment protection rule.
" }, { "type": "string", "name": "event", "in": "body", "description": "The event that triggered the deployment protection rule.
" }, { "type": "string", "name": "deployment_callback_url", "in": "body", "description": "The URL to review the deployment protection rule.
" }, { "type": "object", "name": "deployment", "in": "body", "description": "A request for a specific ref(branch,sha,tag) to be deployed
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref to deploy. This can be a branch, tag, or sha.
", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "object or string", "name": "payload", "description": "", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] }, { "type": "array of objects", "name": "pull_requests", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "color", "description": "", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true } ] }, { "type": "object", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "active_lock_reason", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "object", "name": "assignee", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_reviewers", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_teams", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "The level of privacy this team should have
" }, { "type": "string", "name": "notification_setting", "description": "The notification setting the team has set
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "ldap_dn", "description": "Distinguished Name (DN) that team maps to within LDAP environment
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "commits", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "statuses", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "html", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comment", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "enabled_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "string", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true } ] }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
" }, { "type": "boolean", "name": "merged", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "", "isRequired": true }, { "type": "object", "name": "merged_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
", "isRequired": true }, { "type": "integer", "name": "commits", "description": "", "isRequired": true }, { "type": "integer", "name": "additions", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "app" ], "action": "requested", "category": "deployment_protection_rule" } }, "deployment_review": { "approved": { "descriptionHtml": "A deployment review was approved.
", "summaryHtml": "This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation or deployment status, use the deployment or deployment_status event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "approved" ], "childParamsGroups": [] }, { "type": "object", "name": "approver", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "comment", "in": "body", "description": "", "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "string", "name": "since", "in": "body", "description": "", "isRequired": true }, { "type": "object", "name": "workflow_job_run", "in": "body", "description": "", "childParamsGroups": [ { "type": "null", "name": "conclusion", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "environment", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "workflow_job_runs", "in": "body", "description": "", "childParamsGroups": [ { "type": "null", "name": "conclusion", "description": "" }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string", "name": "environment", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string or null", "name": "name", "description": "" }, { "type": "string", "name": "status", "description": "" }, { "type": "string", "name": "updated_at", "description": "" } ] }, { "type": "object or null", "name": "workflow_run", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "artifacts_url", "description": "" }, { "type": "string", "name": "cancel_url", "description": "" }, { "type": "integer", "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_url", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "display_title", "description": "", "isRequired": true }, { "type": "string", "name": "event", "description": "", "isRequired": true }, { "type": "string", "name": "head_branch", "description": "", "isRequired": true }, { "type": "object or null", "name": "head_commit", "description": "" }, { "type": "object", "name": "head_repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "string or null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "jobs_url", "description": "" }, { "type": "string", "name": "logs_url", "description": "" }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string or null", "name": "previous_attempt_url", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "array of objects or null", "name": "referenced_workflows", "description": "", "childParamsGroups": [ { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "" }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "string or null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "rerun_url", "description": "" }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "integer", "name": "run_number", "description": "", "isRequired": true }, { "type": "string", "name": "run_started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "requested", "in_progress", "completed", "queued", "waiting", "pending" ] }, { "type": "object or null", "name": "triggering_actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", "name": "workflow_url", "description": "" } ] } ], "availability": [ "app" ], "action": "approved", "category": "deployment_review" }, "rejected": { "descriptionHtml": "A deployment review was rejected.
", "summaryHtml": "This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation or deployment status, use the deployment or deployment_status event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "rejected" ], "childParamsGroups": [] }, { "type": "object", "name": "approver", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "comment", "in": "body", "description": "", "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "string", "name": "since", "in": "body", "description": "", "isRequired": true }, { "type": "object", "name": "workflow_job_run", "in": "body", "description": "", "childParamsGroups": [ { "type": "null", "name": "conclusion", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "environment", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "workflow_job_runs", "in": "body", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "conclusion", "description": "" }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string", "name": "environment", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string or null", "name": "name", "description": "" }, { "type": "string", "name": "status", "description": "" }, { "type": "string", "name": "updated_at", "description": "" } ] }, { "type": "object or null", "name": "workflow_run", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "artifacts_url", "description": "" }, { "type": "string", "name": "cancel_url", "description": "" }, { "type": "integer", "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_url", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "event", "description": "", "isRequired": true }, { "type": "string", "name": "head_branch", "description": "", "isRequired": true }, { "type": "object or null", "name": "head_commit", "description": "" }, { "type": "object", "name": "head_repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "string or null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "jobs_url", "description": "" }, { "type": "string", "name": "logs_url", "description": "" }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string or null", "name": "previous_attempt_url", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "array of objects or null", "name": "referenced_workflows", "description": "", "childParamsGroups": [ { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "" }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "string or null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "rerun_url", "description": "" }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "integer", "name": "run_number", "description": "", "isRequired": true }, { "type": "string", "name": "run_started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "requested", "in_progress", "completed", "queued", "waiting" ] }, { "type": "object or null", "name": "triggering_actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", "name": "workflow_url", "description": "" }, { "type": "string", "name": "display_title", "description": "", "isRequired": true } ] } ], "availability": [ "app" ], "action": "rejected", "category": "deployment_review" }, "requested": { "descriptionHtml": "A deployment review was requested.
", "summaryHtml": "This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation or deployment status, use the deployment or deployment_status event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "requested" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "string", "name": "since", "in": "body", "description": "", "isRequired": true }, { "type": "object", "name": "workflow_job_run", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "null", "name": "conclusion", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "environment", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "workflow_run", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "artifacts_url", "description": "" }, { "type": "string", "name": "cancel_url", "description": "" }, { "type": "integer", "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_url", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "event", "description": "", "isRequired": true }, { "type": "string", "name": "head_branch", "description": "", "isRequired": true }, { "type": "object or null", "name": "head_commit", "description": "" }, { "type": "object", "name": "head_repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "string or null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "jobs_url", "description": "" }, { "type": "string", "name": "logs_url", "description": "" }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string or null", "name": "previous_attempt_url", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "array of objects or null", "name": "referenced_workflows", "description": "", "childParamsGroups": [ { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "" }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "string or null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "rerun_url", "description": "" }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "integer", "name": "run_number", "description": "", "isRequired": true }, { "type": "string", "name": "run_started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "requested", "in_progress", "completed", "queued", "waiting", "pending" ] }, { "type": "object or null", "name": "triggering_actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", "name": "workflow_url", "description": "" }, { "type": "string", "name": "display_title", "description": "", "isRequired": true } ] } ], "availability": [ "app" ], "action": "requested", "category": "deployment_review" } }, "deployment_status": { "created": { "descriptionHtml": "A new deployment status was created.
", "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
The result of the completed check run. This value will be null until the check run has completed.
The SHA of the commit that is being checked.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "The id of the check.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the check run.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "The current status of the check run. Can be queued, in_progress, or completed.
The deployment.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "environment", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "", "isRequired": true }, { "type": "null or string or object", "name": "payload", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, merge_queue_entry, workflow_job, pull_request_review_thread, secret_scanning_alert_location, merge_group
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "boolean", "name": "production_environment", "description": "" }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "task", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "" }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "deployment_status", "in": "body", "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "deployment_url", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "The optional human-readable description added to the status.
", "isRequired": true }, { "type": "string", "name": "environment", "description": "", "isRequired": true }, { "type": "string", "name": "environment_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "log_url", "description": "" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, merge_queue_entry, workflow_job, merge_group, secret_scanning_alert_location
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The new state. Can be pending, success, failure, or error.
The optional link added to the status.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object or null", "name": "workflow", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "badge_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "workflow_run", "in": "body", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "artifacts_url", "description": "" }, { "type": "string", "name": "cancel_url", "description": "" }, { "type": "integer", "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_url", "description": "" }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null, "startup_failure" ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "display_title", "description": "", "isRequired": true }, { "type": "string", "name": "event", "description": "", "isRequired": true }, { "type": "string", "name": "head_branch", "description": "", "isRequired": true }, { "type": "null", "name": "head_commit", "description": "" }, { "type": "object", "name": "head_repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "jobs_url", "description": "" }, { "type": "string", "name": "logs_url", "description": "" }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "null", "name": "previous_attempt_url", "description": "" }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "array of objects or null", "name": "referenced_workflows", "description": "", "childParamsGroups": [ { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "" }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "description": "", "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "null", "name": "description", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "rerun_url", "description": "" }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "integer", "name": "run_number", "description": "", "isRequired": true }, { "type": "string", "name": "run_started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "requested", "in_progress", "completed", "queued", "waiting", "pending" ] }, { "type": "object or null", "name": "triggering_actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", "name": "workflow_url", "description": "" } ] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "deployment_status" } }, "discussion": { "answered": { "descriptionHtml": "A comment on the discussion was marked as the answer.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "child_comment_count", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "discussion_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "null", "name": "parent_id", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "discussion", "in": "body", "description": "A Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "answered", "category": "discussion" }, "category_changed": { "descriptionHtml": "The category of a discussion was changed.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "category_changed", "category": "discussion" }, "closed": { "descriptionHtml": "A discussion was closed.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "closed", "category": "discussion" }, "created": { "descriptionHtml": "A discussion was created.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "discussion" }, "deleted": { "descriptionHtml": "A discussion was deleted.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "discussion" }, "edited": { "descriptionHtml": "The title or body on a discussion was edited, or the category of the discussion was changed.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "discussion" }, "labeled": { "descriptionHtml": "A label was added to a discussion.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "labeled", "category": "discussion" }, "locked": { "descriptionHtml": "A discussion was locked.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "locked", "category": "discussion" }, "pinned": { "descriptionHtml": "A discussion was pinned.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "pinned", "category": "discussion" }, "reopened": { "descriptionHtml": "A discussion was reopened.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reopened", "category": "discussion" }, "transferred": { "descriptionHtml": "A discussion was transferred to another repository.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "new_repository", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "object", "name": "organization", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "object", "name": "custom_properties", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "object or null", "name": "template_repository", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "full_name", "description": "" }, { "type": "object", "name": "owner", "description": "", "childParamsGroups": [ { "type": "string", "name": "login", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string", "name": "description", "description": "" }, { "type": "boolean", "name": "fork", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "archive_url", "description": "" }, { "type": "string", "name": "assignees_url", "description": "" }, { "type": "string", "name": "blobs_url", "description": "" }, { "type": "string", "name": "branches_url", "description": "" }, { "type": "string", "name": "collaborators_url", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "commits_url", "description": "" }, { "type": "string", "name": "compare_url", "description": "" }, { "type": "string", "name": "contents_url", "description": "" }, { "type": "string", "name": "contributors_url", "description": "" }, { "type": "string", "name": "deployments_url", "description": "" }, { "type": "string", "name": "downloads_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "forks_url", "description": "" }, { "type": "string", "name": "git_commits_url", "description": "" }, { "type": "string", "name": "git_refs_url", "description": "" }, { "type": "string", "name": "git_tags_url", "description": "" }, { "type": "string", "name": "git_url", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "" }, { "type": "string", "name": "issue_events_url", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "keys_url", "description": "" }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "string", "name": "languages_url", "description": "" }, { "type": "string", "name": "merges_url", "description": "" }, { "type": "string", "name": "milestones_url", "description": "" }, { "type": "string", "name": "notifications_url", "description": "" }, { "type": "string", "name": "pulls_url", "description": "" }, { "type": "string", "name": "releases_url", "description": "" }, { "type": "string", "name": "ssh_url", "description": "" }, { "type": "string", "name": "stargazers_url", "description": "" }, { "type": "string", "name": "statuses_url", "description": "" }, { "type": "string", "name": "subscribers_url", "description": "" }, { "type": "string", "name": "subscription_url", "description": "" }, { "type": "string", "name": "tags_url", "description": "" }, { "type": "string", "name": "teams_url", "description": "" }, { "type": "string", "name": "trees_url", "description": "" }, { "type": "string", "name": "clone_url", "description": "" }, { "type": "string", "name": "mirror_url", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "svn_url", "description": "" }, { "type": "string", "name": "homepage", "description": "" }, { "type": "string", "name": "language", "description": "" }, { "type": "integer", "name": "forks_count", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "" }, { "type": "integer", "name": "watchers_count", "description": "" }, { "type": "integer", "name": "size", "description": "" }, { "type": "string", "name": "default_branch", "description": "" }, { "type": "integer", "name": "open_issues_count", "description": "" }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "" }, { "type": "boolean", "name": "has_projects", "description": "" }, { "type": "boolean", "name": "has_wiki", "description": "" }, { "type": "boolean", "name": "has_pages", "description": "" }, { "type": "boolean", "name": "has_downloads", "description": "" }, { "type": "boolean", "name": "archived", "description": "" }, { "type": "boolean", "name": "disabled", "description": "" }, { "type": "string", "name": "visibility", "description": "" }, { "type": "string", "name": "pushed_at", "description": "" }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string", "name": "updated_at", "description": "" }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "" }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "push", "description": "" }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "pull", "description": "" } ] }, { "type": "boolean", "name": "allow_rebase_merge", "description": "" }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "" }, { "type": "boolean", "name": "allow_auto_merge", "description": "" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "" }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "" }, { "type": "string", "name": "squash_merge_commit_title", "description": "The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "subscribers_count", "description": "" }, { "type": "integer", "name": "network_count", "description": "" }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" } ] } ] }, { "type": "object", "name": "discussion", "in": "body", "description": "A Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "transferred", "category": "discussion" }, "unanswered": { "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "old_answer", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "child_comment_count", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "discussion_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "null", "name": "parent_id", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unanswered", "category": "discussion" }, "unlabeled": { "descriptionHtml": "A label was removed from a discussion.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unlabeled", "category": "discussion" }, "unlocked": { "descriptionHtml": "A discussion was unlocked.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unlocked", "category": "discussion" }, "unpinned": { "descriptionHtml": "A discussion was unpinned.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unpinned", "category": "discussion" } }, "discussion_comment": { "created": { "descriptionHtml": "A comment on a discussion was created.
", "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "discussion_comment" }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "discussion_comment" }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true }, { "type": "string or null", "name": "answer_chosen_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "answer_chosen_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "object", "name": "category", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "emoji", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", "isRequired": true, "enum": [ "resolved", "outdated", "duplicate", "reopened", null ] }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Optional description of the label, such as its purpose.
", "isRequired": true }, { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "Whether this label comes by default in a new repository.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "discussion_comment" } }, "dismissal_request_code_scanning": { "created": { "descriptionHtml": "A code scanning alert dismissal request was created.
", "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "dismissal_request_code_scanning" }, "response_submitted": { "descriptionHtml": "A code scanning alert dismissal response was submitted.
", "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "response_submitted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "exemption_response", "in": "body", "description": "A response to an exemption request by a delegated bypasser.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "response_submitted", "category": "dismissal_request_code_scanning" } }, "dismissal_request_secret_scanning": { "cancelled": { "descriptionHtml": "A secret scanning alert dismissal request was canceled.
", "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "cancelled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "cancelled", "category": "dismissal_request_secret_scanning" }, "completed": { "descriptionHtml": "A secret scanning alert dismissal request was completed.
", "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "completed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "completed", "category": "dismissal_request_secret_scanning" }, "created": { "descriptionHtml": "A secret scanning alert dismissal request was created.
", "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "dismissal_request_secret_scanning" }, "response_dismissed": { "descriptionHtml": "A secret scanning alert dismissal response was dismissed.
", "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "response_dismissed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "exemption_response", "in": "body", "description": "A response to an exemption request by a delegated bypasser.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "response_dismissed", "category": "dismissal_request_secret_scanning" }, "response_submitted": { "descriptionHtml": "A secret scanning alert dismissal response was submitted.
", "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "response_submitted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "exemption_response", "in": "body", "description": "A response to an exemption request by a delegated bypasser.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "response_submitted", "category": "dismissal_request_secret_scanning" } }, "enterprise": { "anonymous_access_disabled": { "descriptionHtml": "Anonymous Git read access was disabled.
", "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "anonymous_access_disabled" ], "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "business" ], "action": "anonymous_access_disabled", "category": "enterprise" }, "anonymous_access_enabled": { "descriptionHtml": "Anonymous Git read access was enabled.
", "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "anonymous_access_enabled" ], "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "business" ], "action": "anonymous_access_enabled", "category": "enterprise" } }, "exemption_request_push_ruleset": { "cancelled": { "descriptionHtml": "A push ruleset bypass request was cancelled.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "cancelled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "cancelled", "category": "exemption_request_push_ruleset" }, "completed": { "descriptionHtml": "A push ruleset bypass request was completed.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "completed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "completed", "category": "exemption_request_push_ruleset" }, "created": { "descriptionHtml": "A push ruleset bypass request was created.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "exemption_request_push_ruleset" }, "response_dismissed": { "descriptionHtml": "A push ruleset bypass response was dismissed.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "response_dismissed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "exemption_response", "in": "body", "description": "A response to an exemption request by a delegated bypasser.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "response_dismissed", "category": "exemption_request_push_ruleset" }, "response_submitted": { "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "response_submitted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption request.
" }, { "type": "integer or null", "name": "number", "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", "name": "requester_id", "description": "The ID of the user who requested the exemption.
" }, { "type": "string", "name": "requester_login", "description": "The login of the user who requested the exemption.
" }, { "type": "string", "name": "request_type", "description": "The type of request.
", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal" ] }, { "type": "object", "name": "exemption_request_data", "description": "", "childParamsGroups": [ { "type": "object", "name": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "push_ruleset_bypass" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the push rules that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "integer", "name": "ruleset_id", "description": "The ID of the ruleset for the rules that were violated
" }, { "type": "string", "name": "ruleset_name", "description": "The name of the ruleset for the rules that were violated
" }, { "type": "integer", "name": "total_violations", "description": "The number of violations
" }, { "type": "string", "name": "rule_type", "description": "The type of rule that was violated
" } ] } ] }, { "type": "object", "name": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning" ] }, { "type": "array of objects", "name": "data", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", "childParamsGroups": [ { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "array of objects", "name": "locations", "description": "The location data of the secret that was detected
", "childParamsGroups": [ { "type": "string", "name": "commit", "description": "The commit SHA where the secret was detected
" }, { "type": "string", "name": "branch", "description": "The branch where the secret was detected
" }, { "type": "string", "name": "path", "description": "The path of the file where the secret was detected
" } ] } ] } ] }, { "type": "object", "name": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "secret_scanning_closure" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the secret scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "reason", "description": "The reason for the dismissal request
", "enum": [ "fixed_later", "false_positive", "tests", "revoked" ] }, { "type": "string", "name": "secret_type", "description": "The type of secret that was detected
" }, { "type": "string", "name": "alert_number", "description": "The number of the alert that was detected
" } ] } ] }, { "type": "object", "name": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of request
", "enum": [ "code_scanning_alert_dismissal" ] }, { "type": "array of objects", "name": "data", "description": "The data related to the code scanning alerts that have dismissal requests.
", "childParamsGroups": [ { "type": "string", "name": "alert_number", "description": "The number of the alert to be dismissed
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "resource_identifier", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", "name": "status", "description": "The status of the exemption request.
", "enum": [ "pending", "rejected", "cancelled", "completed" ] }, { "type": "string or null", "name": "requester_comment", "description": "The comment the requester provided when creating the exemption request.
" }, { "type": "object or null", "name": "metadata", "description": "Metadata about the exemption request.
" }, { "type": "string", "name": "expires_at", "description": "The date and time the exemption request will expire.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" }, { "type": "array of objects or null", "name": "responses", "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", "name": "html_url", "description": "The URL to view the exemption request in a browser.
" } ] }, { "type": "object", "name": "exemption_response", "in": "body", "description": "A response to an exemption request by a delegated bypasser.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the exemption response.
" }, { "type": "integer", "name": "reviewer_id", "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", "name": "reviewer_login", "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", "name": "status", "description": "The status of the exemption response.
", "enum": [ "approved", "rejected", "dismissed" ] }, { "type": "string or null", "name": "reviewer_comment", "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", "name": "created_at", "description": "The date and time the exemption request was created.
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "response_submitted", "category": "exemption_request_push_ruleset" } }, "fork": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "object", "name": "enterprise", "in": "body", "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.\"
The created repository resource.
Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "default", "category": "fork" } }, "github_app_authorization": { "revoked": { "descriptionHtml": "Someone revoked their authorization of a GitHub App.
", "summaryHtml": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.
\nAnyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "revoked", "category": "github_app_authorization" } }, "gollum": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The pages that were updated.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "action", "description": "The action that was performed on the page. Can be created or edited.
Points to the HTML wiki page.
", "isRequired": true }, { "type": "string", "name": "page_name", "description": "The name of the page.
", "isRequired": true }, { "type": "string", "name": "sha", "description": "The latest commit SHA of the page.
", "isRequired": true }, { "type": "string or null", "name": "summary", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "The current page title.
", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "gollum" } }, "installation": { "created": { "descriptionHtml": "Someone installed a GitHub App on a user or organization account.
", "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
Installation
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An array of repository objects that the installation can access.
", "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "created", "category": "installation" }, "deleted": { "descriptionHtml": "Someone uninstalled a GitHub App from their user or organization account.
", "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
Installation
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An array of repository objects that the installation can access.
", "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "deleted", "category": "installation" }, "new_permissions_accepted": { "descriptionHtml": "Someone granted new permissions to a GitHub App.
", "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "new_permissions_accepted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
Installation
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An array of repository objects that the installation can access.
", "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "new_permissions_accepted", "category": "installation" }, "suspend": { "descriptionHtml": "Someone blocked access by a GitHub App to their user or organization account.
", "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "suspend" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
Installation
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An array of repository objects that the installation can access.
", "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "suspend", "category": "installation" }, "unsuspend": { "descriptionHtml": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.
", "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unsuspend" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
Installation
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An array of repository objects that the installation can access.
", "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "unsuspend", "category": "installation" } }, "installation_repositories": { "added": { "descriptionHtml": "A GitHub App installation was granted access to one or more repositories.
", "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "added" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
Installation
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An array of repository objects, which were added to the installation.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "array of objects", "name": "repositories_removed", "in": "body", "description": "An array of repository objects, which were removed from the installation.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
" }, { "type": "string", "name": "name", "description": "The name of the repository.
" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
" } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
Describe whether all repositories have been selected or there's a selection involved
", "isRequired": true, "enum": [ "all", "selected" ] }, { "type": "object or null", "name": "requester", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "added", "category": "installation_repositories" }, "removed": { "descriptionHtml": "Access to one or more repositories was revoked for a GitHub App installation.
", "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "removed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
Installation
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An array of repository objects, which were added to the installation.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "array of objects", "name": "repositories_removed", "in": "body", "description": "An array of repository objects, which were removed from the installation.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
Describe whether all repositories have been selected or there's a selection involved
", "isRequired": true, "enum": [ "all", "selected" ] }, { "type": "object or null", "name": "requester", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "removed", "category": "installation_repositories" } }, "installation_target": { "renamed": { "descriptionHtml": "Somebody renamed the user or organization account that a GitHub App is installed on.
", "summaryHtml": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "object", "name": "account", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "archived_at", "description": "" }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "" }, { "type": "null", "name": "description", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "integer", "name": "followers", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "integer", "name": "following", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "boolean", "name": "has_organization_projects", "description": "" }, { "type": "boolean", "name": "has_repository_projects", "description": "" }, { "type": "string", "name": "hooks_url", "description": "" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_verified", "description": "" }, { "type": "string", "name": "issues_url", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "integer", "name": "public_gists", "description": "" }, { "type": "string", "name": "public_members_url", "description": "" }, { "type": "integer", "name": "public_repos", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "updated_at", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "null", "name": "website_url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "renamed" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "login", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "", "isRequired": true } ] }, { "type": "object", "name": "slug", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] }, { "type": "string", "name": "target_type", "in": "body", "description": "", "isRequired": true } ], "availability": [ "app" ], "action": "renamed", "category": "installation_target" } }, "issue_comment": { "created": { "descriptionHtml": "A comment on an issue or pull request was created.
", "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "comment", "in": "body", "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue the comment belongs to.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "" }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "issue_comment" }, "deleted": { "descriptionHtml": "A comment on an issue or pull request was deleted.
", "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "comment", "in": "body", "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue the comment belongs to.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "" }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "issue_comment" }, "edited": { "descriptionHtml": "A comment on an issue or pull request was edited.
", "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the comment.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "The previous version of the body.
", "isRequired": true } ] } ] }, { "type": "object", "name": "comment", "in": "body", "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue the comment belongs to.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "" }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "issue_comment" } }, "issues": { "assigned": { "descriptionHtml": "An issue was assigned to a user.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "The action that was performed.
", "isRequired": true, "enum": [ "assigned" ], "childParamsGroups": [] }, { "type": "object or null", "name": "assignee", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "assigned", "category": "issues" }, "closed": { "descriptionHtml": "An issue was closed.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "The action that was performed.
", "isRequired": true, "enum": [ "closed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "" }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of object,nulls", "name": "labels", "description": "" }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "" }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "closed", "open" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "closed", "category": "issues" }, "deleted": { "descriptionHtml": "An issue was deleted.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "issues" }, "demilestoned": { "descriptionHtml": "An issue was removed from a milestone.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "demilestoned" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of object,nulls", "name": "labels", "description": "" }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "milestone", "in": "body", "description": "A collection of related issues and pull requests.
", "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "demilestoned", "category": "issues" }, "edited": { "descriptionHtml": "The title or body on an issue was edited.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the issue.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "The previous version of the body.
", "isRequired": true } ] }, { "type": "object", "name": "title", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "The previous version of the title.
", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, security_and_analysis, pull_request_review_thread, reminder
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "label", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "issues" }, "labeled": { "descriptionHtml": "A label was added to an issue.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "labeled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, reminder
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "label", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "labeled", "category": "issues" }, "locked": { "descriptionHtml": "Conversation on an issue was locked. For more information, see \"Locking conversations.\"
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "locked" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of object,nulls", "name": "labels", "description": "" }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true, "enum": [ true ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, security_and_analysis
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "locked", "category": "issues" }, "milestoned": { "descriptionHtml": "An issue was added to a milestone.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "milestoned" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of object,nulls", "name": "labels", "description": "" }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "milestone", "in": "body", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "milestoned", "category": "issues" }, "opened": { "descriptionHtml": "An issue was created. When a closed issue is reopened, the action will be reopened instead.
This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "opened" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "old_issue", "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "" }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
" }, { "type": "string or null", "name": "closed_at", "description": "" }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "" }, { "type": "string", "name": "created_at", "description": "" }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "" }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "" }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "" }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
" }, { "type": "string", "name": "updated_at", "description": "" }, { "type": "string", "name": "url", "description": "URL for the issue
" }, { "type": "object or null", "name": "user", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] } ] }, { "type": "object", "name": "old_repository", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object", "name": "custom_properties", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
" }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether the repository has discussions enabled.
" }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require commit signoff.
" } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, security_and_analysis, pull_request_review_thread, reminder
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "opened", "category": "issues" }, "pinned": { "descriptionHtml": "An issue was pinned to a repository. For more information, see \"Pinning an issue to your repository.\"
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "pinned" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "pinned", "category": "issues" }, "reopened": { "descriptionHtml": "A closed issue was reopened.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "reopened" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of object,nulls", "name": "labels", "description": "" }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, reminder
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reopened", "category": "issues" }, "transferred": { "descriptionHtml": "An issue was transferred to another repository. For more information, see \"Transferring an issue to another repository.\"
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "transferred" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "new_issue", "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "new_repository", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object", "name": "custom_properties", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
" }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "transferred", "category": "issues" }, "unassigned": { "descriptionHtml": "A user was unassigned from an issue.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "The action that was performed.
", "isRequired": true, "enum": [ "unassigned" ], "childParamsGroups": [] }, { "type": "object or null", "name": "assignee", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unassigned", "category": "issues" }, "unlabeled": { "descriptionHtml": "A label was removed from an issue.
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unlabeled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "label", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unlabeled", "category": "issues" }, "unlocked": { "descriptionHtml": "Conversation on an issue was locked. For more information, see \"Locking conversations.\"
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unlocked" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of object,nulls", "name": "labels", "description": "" }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true, "enum": [ false ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unlocked", "category": "issues" }, "unpinned": { "descriptionHtml": "An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"
", "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unpinned" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The issue itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "active_lock_reason", "description": "", "isRequired": true, "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, { "type": "object or null", "name": "assignee", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of object,nulls", "name": "assignees", "description": "", "isRequired": true }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "Contents of the issue
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "locked", "description": "" }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "object or null", "name": "performed_via_github_app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run
Unique identifier of the GitHub app
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the GitHub app
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "The set of permissions for the GitHub app
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "content_references", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "emails", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "keys", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "members", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_scanning_alert", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "", "enum": [ "read", "write" ] } ] }, { "type": "string", "name": "slug", "description": "The slug name of the GitHub app
" }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "childParamsGroups": [ { "type": "string", "name": "diff_url", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "" }, { "type": "string", "name": "patch_url", "description": "" }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "object", "name": "sub_issues_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "total", "description": "", "isRequired": true }, { "type": "integer", "name": "completed", "description": "", "isRequired": true }, { "type": "integer", "name": "percent_completed", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue_dependencies_summary", "description": "", "childParamsGroups": [ { "type": "integer", "name": "blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "blocking", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocked_by", "description": "", "isRequired": true }, { "type": "integer", "name": "total_blocking", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "issue_field_values", "description": "", "childParamsGroups": [ { "type": "integer", "name": "issue_field_id", "description": "Unique identifier for the issue field.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "data_type", "description": "The data type of the issue field
", "isRequired": true, "enum": [ "text", "single_select", "number", "date" ] }, { "type": "null or string or number or integer", "name": "value", "description": "The value of the issue field
", "isRequired": true }, { "type": "object or null", "name": "single_select_option", "description": "Details about the selected option (only present for single_select fields)
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier for the option.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the option
", "isRequired": true }, { "type": "string", "name": "color", "description": "The color of the option
", "isRequired": true } ] } ] }, { "type": "string", "name": "state", "description": "State of the issue; either 'open' or 'closed'
", "enum": [ "open", "closed" ] }, { "type": "string or null", "name": "state_reason", "description": "" }, { "type": "string", "name": "timeline_url", "description": "" }, { "type": "string", "name": "title", "description": "Title of the issue
", "isRequired": true }, { "type": "object or null", "name": "type", "description": "The type of issue.
", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The unique identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node identifier of the issue type.
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "The description of the issue type.
", "isRequired": true }, { "type": "string or null", "name": "color", "description": "The color of the issue type.
", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, { "type": "string", "name": "created_at", "description": "The time the issue type created.
" }, { "type": "string", "name": "updated_at", "description": "The time the issue type last updated.
" }, { "type": "boolean", "name": "is_enabled", "description": "The enabled state of the issue type.
" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the issue
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unpinned", "category": "issues" } }, "label": { "created": { "descriptionHtml": "A label was created.
", "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "label" }, "deleted": { "descriptionHtml": "A label was deleted.
", "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "label" }, "edited": { "descriptionHtml": "A label's name, description, or color was changed.
", "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the label if the action was edited.
The previous version of the color if the action was edited.
The previous version of the description if the action was edited.
The previous version of the name if the action was edited.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "label" } }, "member": { "added": { "descriptionHtml": "A GitHub user accepted an invitation to a repository.
", "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "added" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "childParamsGroups": [ { "type": "object", "name": "permission", "description": "This field is included for legacy purposes; use the role_name field instead. The maintain\nrole is mapped to write and the triage role is mapped to read. To determine the role\nassigned to the collaborator, use the role_name field instead, which will provide the full\nrole name, including custom roles.
The role assigned to the collaborator.
", "childParamsGroups": [ { "type": "string", "name": "to", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "added", "category": "member" }, "edited": { "descriptionHtml": "Permissions were changed for a collaborator on a repository.
", "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the collaborator permissions
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "old_permission", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "The previous permissions of the collaborator if the action was edited.
", "isRequired": true } ] }, { "type": "object", "name": "permission", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "from", "description": "" }, { "type": "string or null", "name": "to", "description": "" } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "edited", "category": "member" }, "removed": { "descriptionHtml": "A collaborator was removed from a repository.
", "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "removed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "removed", "category": "member" } }, "membership": { "added": { "descriptionHtml": "An organization member was added to a team.
", "summaryHtml": "This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "added" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The scope of the membership. Currently, can only be team.
Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "isRequired": true, "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "", "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] } ], "availability": [ "organization", "business", "app" ], "action": "added", "category": "membership" }, "removed": { "descriptionHtml": "An organization member was removed from a team.
", "summaryHtml": "This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "removed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The scope of the membership. Currently, can only be team.
Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "isRequired": true, "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "", "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] } ], "availability": [ "organization", "business", "app" ], "action": "removed", "category": "membership" } }, "meta": { "deleted": { "descriptionHtml": "The webhook was deleted.
", "summaryHtml": "This event occurs when there is activity relating to a webhook itself.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "active", "description": "", "isRequired": true }, { "type": "object", "name": "config", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "content_type", "description": "", "isRequired": true, "enum": [ "json", "form" ] }, { "type": "string", "name": "insecure_ssl", "description": "", "isRequired": true }, { "type": "string", "name": "secret", "description": "" }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "array of strings", "name": "events", "description": "Supported values are: *, branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, create, delete, deployment, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, meta, milestone, organization, org_block, package, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, pull_request_review_thread, push, registry_package, release, repository, repository_import, repository_vulnerability_alert, secret_scanning_alert, secret_scanning_alert_location, security_and_analysis, star, status, team, team_add, watch, workflow_job, workflow_run, repository_dispatch, projects_v2_item
The id of the modified webhook.
", "isRequired": true }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "marketplace", "business", "repository", "organization", "app" ], "action": "deleted", "category": "meta" } }, "milestone": { "closed": { "descriptionHtml": "A milestone was closed.
", "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "closed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "closed", "category": "milestone" }, "created": { "descriptionHtml": "A milestone was created.
", "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "milestone" }, "deleted": { "descriptionHtml": "A milestone was deleted.
", "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "milestone" }, "edited": { "descriptionHtml": "A milestone was edited.
", "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the milestone if the action was edited.
The previous version of the description if the action was edited.
The previous version of the due date if the action was edited.
The previous version of the title if the action was edited.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "milestone" }, "opened": { "descriptionHtml": "A milestone was opened.
", "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "opened" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "opened", "category": "milestone" } }, "organization": { "deleted": { "descriptionHtml": "An organization was deleted.
", "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The membership between the user and the organization. Not present when the action is member_invited.
Whether the user has direct membership in the organization.
" }, { "type": "array of strings", "name": "enterprise_teams_providing_indirect_membership", "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.
" }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization", "business", "app" ], "action": "deleted", "category": "organization" }, "member_added": { "descriptionHtml": "A member accepted an invitation to join an organization.
", "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "member_added" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The membership between the user and the organization. Not present when the action is member_invited.
Whether the user has direct membership in the organization.
" }, { "type": "array of strings", "name": "enterprise_teams_providing_indirect_membership", "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.
" }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization", "business", "app" ], "action": "member_added", "category": "organization" }, "member_invited": { "descriptionHtml": "A member was invited to join the organization.
", "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "member_invited" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The invitation for the user or email if the action is member_invited.
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object or null", "name": "user", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ], "availability": [ "organization", "business", "app" ], "action": "member_invited", "category": "organization" }, "member_removed": { "descriptionHtml": "A member was removed from the organization.
", "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "member_removed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The membership between the user and the organization. Not present when the action is member_invited.
Whether the user has direct membership in the organization.
" }, { "type": "array of strings", "name": "enterprise_teams_providing_indirect_membership", "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.
" }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization", "business", "app" ], "action": "member_removed", "category": "organization" }, "renamed": { "descriptionHtml": "The name of an organization was changed.
", "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "renamed" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "childParamsGroups": [ { "type": "object", "name": "login", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "" } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The membership between the user and the organization. Not present when the action is member_invited.
Whether the user has direct membership in the organization.
" }, { "type": "array of strings", "name": "enterprise_teams_providing_indirect_membership", "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.
" }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization", "business", "app" ], "action": "renamed", "category": "organization" } }, "package": { "published": { "descriptionHtml": "A package was published to a registry.
", "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "published" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Information about the package.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "ecosystem", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "namespace", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "package_type", "description": "", "isRequired": true }, { "type": "object or null", "name": "package_version", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "author", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or object", "name": "body", "description": "" }, { "type": "string", "name": "body_html", "description": "" }, { "type": "object or null", "name": "container_metadata", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "labels", "description": "" }, { "type": "object or null", "name": "manifest", "description": "" }, { "type": "object", "name": "tag", "description": "", "childParamsGroups": [ { "type": "string", "name": "digest", "description": "" }, { "type": "string", "name": "name", "description": "" } ] } ] }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "array of objects", "name": "docker_metadata", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "tags", "description": "" } ] }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "installation_command", "description": "", "isRequired": true }, { "type": "string", "name": "manifest", "description": "" }, { "type": "array of objects", "name": "metadata", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "object or null", "name": "npm_metadata", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "version", "description": "" }, { "type": "string", "name": "npm_user", "description": "" }, { "type": "object or null", "name": "author", "description": "" }, { "type": "object or null", "name": "bugs", "description": "" }, { "type": "object", "name": "dependencies", "description": "" }, { "type": "object", "name": "dev_dependencies", "description": "" }, { "type": "object", "name": "peer_dependencies", "description": "" }, { "type": "object", "name": "optional_dependencies", "description": "" }, { "type": "string", "name": "description", "description": "" }, { "type": "object or null", "name": "dist", "description": "" }, { "type": "string", "name": "git_head", "description": "" }, { "type": "string", "name": "homepage", "description": "" }, { "type": "string", "name": "license", "description": "" }, { "type": "string", "name": "main", "description": "" }, { "type": "object or null", "name": "repository", "description": "" }, { "type": "object", "name": "scripts", "description": "" }, { "type": "string", "name": "id", "description": "" }, { "type": "string", "name": "node_version", "description": "" }, { "type": "string", "name": "npm_version", "description": "" }, { "type": "boolean", "name": "has_shrinkwrap", "description": "" }, { "type": "array of objects", "name": "maintainers", "description": "" }, { "type": "array of objects", "name": "contributors", "description": "" }, { "type": "object", "name": "engines", "description": "" }, { "type": "array of strings", "name": "keywords", "description": "" }, { "type": "array of strings", "name": "files", "description": "" }, { "type": "object", "name": "bin", "description": "" }, { "type": "object", "name": "man", "description": "" }, { "type": "object or null", "name": "directories", "description": "" }, { "type": "array of strings", "name": "os", "description": "" }, { "type": "array of strings", "name": "cpu", "description": "" }, { "type": "string", "name": "readme", "description": "" }, { "type": "string", "name": "installation_command", "description": "" }, { "type": "integer", "name": "release_id", "description": "" }, { "type": "string", "name": "commit_oid", "description": "" }, { "type": "boolean", "name": "published_via_actions", "description": "" }, { "type": "integer", "name": "deleted_by_id", "description": "" } ] }, { "type": "array of objects or null", "name": "nuget_metadata", "description": "", "childParamsGroups": [ { "type": "integer or string", "name": "id", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "boolean or string or integer or object", "name": "value", "description": "" } ] }, { "type": "array of objects", "name": "package_files", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "content_type", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "download_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string or null", "name": "md5", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "sha1", "description": "", "isRequired": true }, { "type": "string or null", "name": "sha256", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string or null", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "string", "name": "package_url", "description": "" }, { "type": "boolean", "name": "prerelease", "description": "" }, { "type": "object", "name": "release", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "", "isRequired": true }, { "type": "string", "name": "published_at", "description": "", "isRequired": true }, { "type": "string", "name": "tag_name", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "rubygems_metadata", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "description", "description": "" }, { "type": "string", "name": "readme", "description": "" }, { "type": "string", "name": "homepage", "description": "" }, { "type": "object", "name": "version_info", "description": "", "childParamsGroups": [ { "type": "string", "name": "version", "description": "" } ] }, { "type": "string", "name": "platform", "description": "" }, { "type": "object", "name": "metadata", "description": "" }, { "type": "string", "name": "repo", "description": "" }, { "type": "array of objects", "name": "dependencies", "description": "" }, { "type": "string", "name": "commit_oid", "description": "" } ] }, { "type": "string", "name": "source_url", "description": "" }, { "type": "string", "name": "summary", "description": "", "isRequired": true }, { "type": "string", "name": "tag_name", "description": "" }, { "type": "string", "name": "target_commitish", "description": "" }, { "type": "string", "name": "target_oid", "description": "" }, { "type": "string", "name": "updated_at", "description": "" }, { "type": "string", "name": "version", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "registry", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "about_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "vendor", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "published", "category": "package" }, "updated": { "descriptionHtml": "A previously published package was updated.
", "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "updated" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Information about the package.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "ecosystem", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "namespace", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "package_type", "description": "", "isRequired": true }, { "type": "object", "name": "package_version", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "body", "description": "", "isRequired": true }, { "type": "string", "name": "body_html", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "array of objects", "name": "docker_metadata", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "tags", "description": "" } ] }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "installation_command", "description": "", "isRequired": true }, { "type": "string", "name": "manifest", "description": "" }, { "type": "array of objects", "name": "metadata", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "array of objects", "name": "package_files", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "content_type", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "download_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string or null", "name": "md5", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "sha1", "description": "", "isRequired": true }, { "type": "string", "name": "sha256", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "string", "name": "package_url", "description": "" }, { "type": "boolean", "name": "prerelease", "description": "" }, { "type": "object", "name": "release", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "", "isRequired": true }, { "type": "string", "name": "published_at", "description": "", "isRequired": true }, { "type": "string", "name": "tag_name", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "array of objects", "name": "rubygems_metadata", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "description", "description": "" }, { "type": "string", "name": "readme", "description": "" }, { "type": "string", "name": "homepage", "description": "" }, { "type": "object", "name": "version_info", "description": "", "childParamsGroups": [ { "type": "string", "name": "version", "description": "" } ] }, { "type": "string", "name": "platform", "description": "" }, { "type": "object", "name": "metadata", "description": "" }, { "type": "string", "name": "repo", "description": "" }, { "type": "array of objects", "name": "dependencies", "description": "" }, { "type": "string", "name": "commit_oid", "description": "" } ] }, { "type": "string", "name": "source_url", "description": "" }, { "type": "string", "name": "summary", "description": "", "isRequired": true }, { "type": "string", "name": "tag_name", "description": "" }, { "type": "string", "name": "target_commitish", "description": "", "isRequired": true }, { "type": "string", "name": "target_oid", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "version", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "registry", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "about_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "vendor", "description": "", "isRequired": true } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "updated", "category": "package" } }, "page_build": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"Configuring a publishing source for your GitHub Pages site.\" For information about the API to manage GitHub Pages, see \"Pages\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.
", "bodyParameters": [ { "type": "object", "name": "build", "in": "body", "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "duration", "description": "", "isRequired": true }, { "type": "object", "name": "error", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "message", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "pusher", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "status", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "page_build" } }, "personal_access_token_request": { "approved": { "descriptionHtml": "A fine-grained personal access token request was approved.
", "summaryHtml": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "approved" ], "childParamsGroups": [] }, { "type": "object", "name": "personal_access_token_request", "in": "body", "description": "Details of a Personal Access Token Request.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions_added", "description": "New requested permissions, categorized by type of permission.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "" }, { "type": "object", "name": "repository", "description": "" }, { "type": "object", "name": "other", "description": "" } ] }, { "type": "object", "name": "permissions_upgraded", "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "" }, { "type": "object", "name": "repository", "description": "" }, { "type": "object", "name": "other", "description": "" } ] }, { "type": "object", "name": "permissions_result", "description": "Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
Type of repository selection requested.
", "isRequired": true, "enum": [ "none", "all", "subset" ] }, { "type": "integer or null", "name": "repository_count", "description": "The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.
An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.
Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "string", "name": "created_at", "description": "Date and time when the request for access was created.
", "isRequired": true }, { "type": "integer", "name": "token_id", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.
", "isRequired": true }, { "type": "string", "name": "token_name", "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.
", "isRequired": true }, { "type": "boolean", "name": "token_expired", "description": "Whether the associated fine-grained personal access token has expired.
", "isRequired": true }, { "type": "string or null", "name": "token_expires_at", "description": "Date and time when the associated fine-grained personal access token expires.
", "isRequired": true }, { "type": "string or null", "name": "token_last_used_at", "description": "Date and time when the associated fine-grained personal access token was last used for authentication.
", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A fine-grained personal access token request was cancelled by the requester.
", "summaryHtml": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "cancelled" ], "childParamsGroups": [] }, { "type": "object", "name": "personal_access_token_request", "in": "body", "description": "Details of a Personal Access Token Request.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions_added", "description": "New requested permissions, categorized by type of permission.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "" }, { "type": "object", "name": "repository", "description": "" }, { "type": "object", "name": "other", "description": "" } ] }, { "type": "object", "name": "permissions_upgraded", "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "" }, { "type": "object", "name": "repository", "description": "" }, { "type": "object", "name": "other", "description": "" } ] }, { "type": "object", "name": "permissions_result", "description": "Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
Type of repository selection requested.
", "isRequired": true, "enum": [ "none", "all", "subset" ] }, { "type": "integer or null", "name": "repository_count", "description": "The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.
An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.
Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "string", "name": "created_at", "description": "Date and time when the request for access was created.
", "isRequired": true }, { "type": "integer", "name": "token_id", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.
", "isRequired": true }, { "type": "string", "name": "token_name", "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.
", "isRequired": true }, { "type": "boolean", "name": "token_expired", "description": "Whether the associated fine-grained personal access token has expired.
", "isRequired": true }, { "type": "string or null", "name": "token_expires_at", "description": "Date and time when the associated fine-grained personal access token expires.
", "isRequired": true }, { "type": "string or null", "name": "token_last_used_at", "description": "Date and time when the associated fine-grained personal access token was last used for authentication.
", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A fine-grained personal access token request was created.
", "summaryHtml": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "personal_access_token_request", "in": "body", "description": "Details of a Personal Access Token Request.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions_added", "description": "New requested permissions, categorized by type of permission.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "" }, { "type": "object", "name": "repository", "description": "" }, { "type": "object", "name": "other", "description": "" } ] }, { "type": "object", "name": "permissions_upgraded", "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "" }, { "type": "object", "name": "repository", "description": "" }, { "type": "object", "name": "other", "description": "" } ] }, { "type": "object", "name": "permissions_result", "description": "Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
Type of repository selection requested.
", "isRequired": true, "enum": [ "none", "all", "subset" ] }, { "type": "integer or null", "name": "repository_count", "description": "The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.
An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.
Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "string", "name": "created_at", "description": "Date and time when the request for access was created.
", "isRequired": true }, { "type": "integer", "name": "token_id", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.
", "isRequired": true }, { "type": "string", "name": "token_name", "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.
", "isRequired": true }, { "type": "boolean", "name": "token_expired", "description": "Whether the associated fine-grained personal access token has expired.
", "isRequired": true }, { "type": "string or null", "name": "token_expires_at", "description": "Date and time when the associated fine-grained personal access token expires.
", "isRequired": true }, { "type": "string or null", "name": "token_last_used_at", "description": "Date and time when the associated fine-grained personal access token was last used for authentication.
", "isRequired": true } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A fine-grained personal access token request was denied.
", "summaryHtml": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "denied" ], "childParamsGroups": [] }, { "type": "object", "name": "personal_access_token_request", "in": "body", "description": "Details of a Personal Access Token Request.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.
A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions_added", "description": "New requested permissions, categorized by type of permission.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "" }, { "type": "object", "name": "repository", "description": "" }, { "type": "object", "name": "other", "description": "" } ] }, { "type": "object", "name": "permissions_upgraded", "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "" }, { "type": "object", "name": "repository", "description": "" }, { "type": "object", "name": "other", "description": "" } ] }, { "type": "object", "name": "permissions_result", "description": "Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
Type of repository selection requested.
", "isRequired": true, "enum": [ "none", "all", "subset" ] }, { "type": "integer or null", "name": "repository_count", "description": "The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.
An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.
Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true } ] }, { "type": "string", "name": "created_at", "description": "Date and time when the request for access was created.
", "isRequired": true }, { "type": "integer", "name": "token_id", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.
", "isRequired": true }, { "type": "string", "name": "token_name", "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.
", "isRequired": true }, { "type": "boolean", "name": "token_expired", "description": "Whether the associated fine-grained personal access token has expired.
", "isRequired": true }, { "type": "string or null", "name": "token_expires_at", "description": "Date and time when the associated fine-grained personal access token expires.
", "isRequired": true }, { "type": "string or null", "name": "token_last_used_at", "description": "Date and time when the associated fine-grained personal access token was last used for authentication.
", "isRequired": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.\"
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.
", "bodyParameters": [ { "type": "object", "name": "hook", "in": "body", "description": "The webhook that is being pinged
", "childParamsGroups": [ { "type": "boolean", "name": "active", "description": "Determines whether the hook is actually triggered for the events it subscribes to.
", "isRequired": true }, { "type": "integer", "name": "app_id", "description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.
" }, { "type": "object", "name": "config", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "content_type", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
The URL to which the payloads will be delivered.
" } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "deliveries_url", "description": "" }, { "type": "array of strings", "name": "events", "description": "Determines what events the hook is triggered for. Default: ['push'].
", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the webhook.
", "isRequired": true }, { "type": "object", "name": "last_response", "description": "", "childParamsGroups": [ { "type": "integer or null", "name": "code", "description": "", "isRequired": true }, { "type": "string or null", "name": "status", "description": "", "isRequired": true }, { "type": "string or null", "name": "message", "description": "", "isRequired": true } ] }, { "type": "string", "name": "name", "description": "The type of webhook. The only valid value is 'web'.
", "isRequired": true, "enum": [ "web" ] }, { "type": "string", "name": "ping_url", "description": "" }, { "type": "string", "name": "test_url", "description": "" }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "integer", "name": "hook_id", "in": "body", "description": "The ID of the webhook that triggered the ping.
" }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] }, { "type": "string", "name": "zen", "in": "body", "description": "Random string of GitHub zen.
" } ], "availability": [ "repository", "organization", "app", "business", "marketplace" ], "action": "default", "category": "ping" } }, "project_card": { "converted": { "descriptionHtml": "A note in a project (classic) was converted to an issue.
", "summaryHtml": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "converted" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "note", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "from", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Whether or not the card is archived
", "isRequired": true }, { "type": "integer", "name": "column_id", "description": "", "isRequired": true }, { "type": "string", "name": "column_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_url", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "id", "description": "The project card's ID
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "note", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "converted", "category": "project_card" }, "created": { "descriptionHtml": "A card was added to a project (classic).
", "summaryHtml": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Whether or not the card is archived
", "isRequired": true }, { "type": "integer", "name": "column_id", "description": "", "isRequired": true }, { "type": "string", "name": "column_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_url", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "id", "description": "The project card's ID
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "note", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "project_card" }, "deleted": { "descriptionHtml": "A card on a project (classic) was deleted.
", "summaryHtml": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Whether or not the card is archived
", "isRequired": true }, { "type": "integer or null", "name": "column_id", "description": "", "isRequired": true }, { "type": "string", "name": "column_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_url", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "id", "description": "The project card's ID
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "note", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "project_card" }, "edited": { "descriptionHtml": "A note on a project (classic) was edited.
", "summaryHtml": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "note", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "from", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Whether or not the card is archived
", "isRequired": true }, { "type": "integer", "name": "column_id", "description": "", "isRequired": true }, { "type": "string", "name": "column_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_url", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "id", "description": "The project card's ID
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "note", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "project_card" }, "moved": { "descriptionHtml": "A card on a project (classic) was moved to another column or to another position in its column.
", "summaryHtml": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "moved" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "childParamsGroups": [ { "type": "object", "name": "column_id", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "from", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Whether or not the card is archived
", "isRequired": true }, { "type": "integer", "name": "column_id", "description": "", "isRequired": true }, { "type": "string", "name": "column_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_url", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "id", "description": "The project card's ID
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "note", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "moved", "category": "project_card" } }, "project": { "closed": { "descriptionHtml": "A project (classic) was closed.
", "summaryHtml": "This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project (classic), use the project_card and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "closed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Body of the project
", "isRequired": true }, { "type": "string", "name": "columns_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "owner_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the project; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "closed", "category": "project" }, "created": { "descriptionHtml": "A project (classic) was created.
", "summaryHtml": "This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project (classic), use the project_card and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Body of the project
", "isRequired": true }, { "type": "string", "name": "columns_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "owner_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the project; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "project" }, "deleted": { "descriptionHtml": "A project (classic) was deleted.
", "summaryHtml": "This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project (classic), use the project_card and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Body of the project
", "isRequired": true }, { "type": "string", "name": "columns_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "owner_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the project; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "project" }, "edited": { "descriptionHtml": "The name or description of a project (classic) was changed.
", "summaryHtml": "This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project (classic), use the project_card and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the project if the action was edited.
The previous version of the body if the action was edited.
The changes to the project if the action was edited.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Body of the project
", "isRequired": true }, { "type": "string", "name": "columns_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "owner_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the project; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "project" }, "reopened": { "descriptionHtml": "A project (classic) was closed.
", "summaryHtml": "This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project (classic), use the project_card and project_column event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "reopened" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Body of the project
", "isRequired": true }, { "type": "string", "name": "columns_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "owner_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the project; either 'open' or 'closed'
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reopened", "category": "project" } }, "project_column": { "created": { "descriptionHtml": "A column was added to a project (classic).
", "summaryHtml": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The unique identifier of the project column
", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project column
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "project_column" }, "deleted": { "descriptionHtml": "A column was deleted from a project (classic).
", "summaryHtml": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The unique identifier of the project column
", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project column
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "project_column" }, "edited": { "descriptionHtml": "The name of a column on a project (classic) was changed.
", "summaryHtml": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "name", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "", "isRequired": true } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The unique identifier of the project column
", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project column
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "project_column" }, "moved": { "descriptionHtml": "A column was moved to a new position on a project (classic).
", "summaryHtml": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "moved" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The unique identifier of the project column
", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the project column
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "project_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "moved", "category": "project_column" } }, "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A projects v2 project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project.
", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "title", "description": "The project title.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "A short description of the project.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "Whether the project is visible to anyone with access to the owner.
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "The time when the project was closed.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time when the project was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the project was last updated.
", "isRequired": true }, { "type": "integer", "name": "number", "description": "The project number.
", "isRequired": true }, { "type": "string or null", "name": "short_description", "description": "A concise summary of the project.
", "isRequired": true }, { "type": "string or null", "name": "deleted_at", "description": "The time when the project was deleted.
", "isRequired": true }, { "type": "object", "name": "deleted_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "state", "description": "The current state of the project.
", "enum": [ "open", "closed" ] }, { "type": "object", "name": "latest_status_update", "description": "An status update belonging to a project
", "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the status update.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the status update.
", "isRequired": true }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that this status update belongs to.
" }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the status update was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the status update was last updated.
", "isRequired": true }, { "type": "string or null", "name": "status", "description": "The current status.
", "enum": [ "INACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETE", null ] }, { "type": "string", "name": "start_date", "description": "The start date of the period covered by the update.
" }, { "type": "string", "name": "target_date", "description": "The target date associated with the update.
" }, { "type": "string or null", "name": "body", "description": "Body of the status update
" } ] }, { "type": "boolean", "name": "is_template", "description": "Whether this project is a template
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "closed", "category": "projects_v2" }, "created": { "descriptionHtml": "A project in the organization was created.
", "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A projects v2 project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project.
", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "title", "description": "The project title.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "A short description of the project.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "Whether the project is visible to anyone with access to the owner.
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "The time when the project was closed.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time when the project was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the project was last updated.
", "isRequired": true }, { "type": "integer", "name": "number", "description": "The project number.
", "isRequired": true }, { "type": "string or null", "name": "short_description", "description": "A concise summary of the project.
", "isRequired": true }, { "type": "string or null", "name": "deleted_at", "description": "The time when the project was deleted.
", "isRequired": true }, { "type": "object", "name": "deleted_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "state", "description": "The current state of the project.
", "enum": [ "open", "closed" ] }, { "type": "object", "name": "latest_status_update", "description": "An status update belonging to a project
", "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the status update.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the status update.
", "isRequired": true }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that this status update belongs to.
" }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the status update was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the status update was last updated.
", "isRequired": true }, { "type": "string or null", "name": "status", "description": "The current status.
", "enum": [ "INACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETE", null ] }, { "type": "string", "name": "start_date", "description": "The start date of the period covered by the update.
" }, { "type": "string", "name": "target_date", "description": "The target date associated with the update.
" }, { "type": "string or null", "name": "body", "description": "Body of the status update
" } ] }, { "type": "boolean", "name": "is_template", "description": "Whether this project is a template
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "created", "category": "projects_v2" }, "deleted": { "descriptionHtml": "A project in the organization was deleted.
", "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A projects v2 project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project.
", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "title", "description": "The project title.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "A short description of the project.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "Whether the project is visible to anyone with access to the owner.
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "The time when the project was closed.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time when the project was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the project was last updated.
", "isRequired": true }, { "type": "integer", "name": "number", "description": "The project number.
", "isRequired": true }, { "type": "string or null", "name": "short_description", "description": "A concise summary of the project.
", "isRequired": true }, { "type": "string or null", "name": "deleted_at", "description": "The time when the project was deleted.
", "isRequired": true }, { "type": "object", "name": "deleted_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "state", "description": "The current state of the project.
", "enum": [ "open", "closed" ] }, { "type": "object", "name": "latest_status_update", "description": "An status update belonging to a project
", "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the status update.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the status update.
", "isRequired": true }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that this status update belongs to.
" }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the status update was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the status update was last updated.
", "isRequired": true }, { "type": "string or null", "name": "status", "description": "The current status.
", "enum": [ "INACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETE", null ] }, { "type": "string", "name": "start_date", "description": "The start date of the period covered by the update.
" }, { "type": "string", "name": "target_date", "description": "The target date associated with the update.
" }, { "type": "string or null", "name": "body", "description": "Body of the status update
" } ] }, { "type": "boolean", "name": "is_template", "description": "Whether this project is a template
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "deleted", "category": "projects_v2" }, "edited": { "descriptionHtml": "The title, description, or README of a project in the organization was changed.
", "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A projects v2 project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project.
", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "title", "description": "The project title.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "A short description of the project.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "Whether the project is visible to anyone with access to the owner.
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "The time when the project was closed.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time when the project was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the project was last updated.
", "isRequired": true }, { "type": "integer", "name": "number", "description": "The project number.
", "isRequired": true }, { "type": "string or null", "name": "short_description", "description": "A concise summary of the project.
", "isRequired": true }, { "type": "string or null", "name": "deleted_at", "description": "The time when the project was deleted.
", "isRequired": true }, { "type": "object", "name": "deleted_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "state", "description": "The current state of the project.
", "enum": [ "open", "closed" ] }, { "type": "object", "name": "latest_status_update", "description": "An status update belonging to a project
", "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the status update.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the status update.
", "isRequired": true }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that this status update belongs to.
" }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the status update was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the status update was last updated.
", "isRequired": true }, { "type": "string or null", "name": "status", "description": "The current status.
", "enum": [ "INACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETE", null ] }, { "type": "string", "name": "start_date", "description": "The start date of the period covered by the update.
" }, { "type": "string", "name": "target_date", "description": "The target date associated with the update.
" }, { "type": "string or null", "name": "body", "description": "Body of the status update
" } ] }, { "type": "boolean", "name": "is_template", "description": "Whether this project is a template
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "edited", "category": "projects_v2" }, "reopened": { "descriptionHtml": "A project in the organization was reopened.
", "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A projects v2 project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project.
", "isRequired": true }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "title", "description": "The project title.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "A short description of the project.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "Whether the project is visible to anyone with access to the owner.
", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "The time when the project was closed.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time when the project was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the project was last updated.
", "isRequired": true }, { "type": "integer", "name": "number", "description": "The project number.
", "isRequired": true }, { "type": "string or null", "name": "short_description", "description": "A concise summary of the project.
", "isRequired": true }, { "type": "string or null", "name": "deleted_at", "description": "The time when the project was deleted.
", "isRequired": true }, { "type": "object", "name": "deleted_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "state", "description": "The current state of the project.
", "enum": [ "open", "closed" ] }, { "type": "object", "name": "latest_status_update", "description": "An status update belonging to a project
", "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the status update.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the status update.
", "isRequired": true }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that this status update belongs to.
" }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the status update was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the status update was last updated.
", "isRequired": true }, { "type": "string or null", "name": "status", "description": "The current status.
", "enum": [ "INACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETE", null ] }, { "type": "string", "name": "start_date", "description": "The start date of the period covered by the update.
" }, { "type": "string", "name": "target_date", "description": "The target date associated with the update.
" }, { "type": "string or null", "name": "body", "description": "Body of the status update
" } ] }, { "type": "boolean", "name": "is_template", "description": "Whether this project is a template
" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "reopened", "category": "projects_v2" } }, "projects_v2_item": { "archived": { "descriptionHtml": "An item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An item belonging to a project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project item.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project item.
" }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that contains this item.
" }, { "type": "string", "name": "content_node_id", "description": "The node ID of the content represented by this item.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The type of content tracked in a project item
", "isRequired": true, "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the item was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the item was last updated.
", "isRequired": true }, { "type": "string or null", "name": "archived_at", "description": "The time when the item was archived.
", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "archived", "category": "projects_v2_item" }, "converted": { "descriptionHtml": "A draft issue in an organization project was converted to an issue.
", "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An item belonging to a project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project item.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project item.
" }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that contains this item.
" }, { "type": "string", "name": "content_node_id", "description": "The node ID of the content represented by this item.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The type of content tracked in a project item
", "isRequired": true, "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the item was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the item was last updated.
", "isRequired": true }, { "type": "string or null", "name": "archived_at", "description": "The time when the item was archived.
", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "converted", "category": "projects_v2_item" }, "created": { "descriptionHtml": "An item was added to a project in the organization.
", "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An item belonging to a project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project item.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project item.
" }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that contains this item.
" }, { "type": "string", "name": "content_node_id", "description": "The node ID of the content represented by this item.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The type of content tracked in a project item
", "isRequired": true, "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the item was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the item was last updated.
", "isRequired": true }, { "type": "string or null", "name": "archived_at", "description": "The time when the item was archived.
", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "created", "category": "projects_v2_item" }, "deleted": { "descriptionHtml": "An item was deleted from a project in the organization.
", "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An item belonging to a project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project item.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project item.
" }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that contains this item.
" }, { "type": "string", "name": "content_node_id", "description": "The node ID of the content represented by this item.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The type of content tracked in a project item
", "isRequired": true, "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the item was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the item was last updated.
", "isRequired": true }, { "type": "string or null", "name": "archived_at", "description": "The time when the item was archived.
", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "deleted", "category": "projects_v2_item" }, "edited": { "descriptionHtml": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
", "childParamsGroups": [ { "type": "object", "description": "", "isRequired": [ "field_value" ], "childParamsGroups": [ { "type": "object", "name": "field_value", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "field_node_id", "description": "" }, { "type": "string", "name": "field_type", "description": "" }, { "type": "string", "name": "field_name", "description": "" }, { "type": "integer", "name": "project_number", "description": "" }, { "type": "null or string or integer or object", "name": "from", "description": "" }, { "type": "null or string or integer or object", "name": "to", "description": "" } ] } ] }, { "type": "object", "description": "", "isRequired": [ "body" ], "childParamsGroups": [ { "type": "object", "name": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "from", "description": "" }, { "type": "string or null", "name": "to", "description": "" } ] } ] } ], "oneOfObject": true }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An item belonging to a project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project item.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project item.
" }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that contains this item.
" }, { "type": "string", "name": "content_node_id", "description": "The node ID of the content represented by this item.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The type of content tracked in a project item
", "isRequired": true, "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the item was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the item was last updated.
", "isRequired": true }, { "type": "string or null", "name": "archived_at", "description": "The time when the item was archived.
", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "edited", "category": "projects_v2_item" }, "reordered": { "descriptionHtml": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An item belonging to a project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project item.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project item.
" }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that contains this item.
" }, { "type": "string", "name": "content_node_id", "description": "The node ID of the content represented by this item.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The type of content tracked in a project item
", "isRequired": true, "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the item was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the item was last updated.
", "isRequired": true }, { "type": "string or null", "name": "archived_at", "description": "The time when the item was archived.
", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "reordered", "category": "projects_v2_item" }, "restored": { "descriptionHtml": "An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
An item belonging to a project
", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "id", "description": "The unique identifier of the project item.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the project item.
" }, { "type": "string", "name": "project_node_id", "description": "The node ID of the project that contains this item.
" }, { "type": "string", "name": "content_node_id", "description": "The node ID of the content represented by this item.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The type of content tracked in a project item
", "isRequired": true, "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "The time when the item was created.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "The time when the item was last updated.
", "isRequired": true }, { "type": "string or null", "name": "archived_at", "description": "The time when the item was archived.
", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "organization" ], "action": "restored", "category": "projects_v2_item" } }, "public": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "public" } }, "pull_request": { "assigned": { "descriptionHtml": "A pull request was assigned to a user.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "assigned" ], "childParamsGroups": [] }, { "type": "object or null", "name": "assignee", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "assigned", "category": "pull_request" }, "auto_merge_disabled": { "descriptionHtml": "Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "auto_merge_disabled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "reason", "in": "body", "description": "", "isRequired": true }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "auto_merge_disabled", "category": "pull_request" }, "auto_merge_enabled": { "descriptionHtml": "Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "auto_merge_enabled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "reason", "in": "body", "description": "" }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "auto_merge_enabled", "category": "pull_request" }, "closed": { "descriptionHtml": "A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.
This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "closed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "color", "description": "", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true } ] }, { "type": "object", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "active_lock_reason", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "object", "name": "assignee", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_reviewers", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_teams", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "The level of privacy this team should have
" }, { "type": "string", "name": "notification_setting", "description": "The notification setting the team has set
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "ldap_dn", "description": "Distinguished Name (DN) that team maps to within LDAP environment
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "commits", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "statuses", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "html", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comment", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "enabled_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "string", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true } ] }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
" }, { "type": "boolean", "name": "merged", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "", "isRequired": true }, { "type": "object", "name": "merged_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
", "isRequired": true }, { "type": "integer", "name": "commits", "description": "", "isRequired": true }, { "type": "integer", "name": "additions", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether to allow updating the pull request's branch.
" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged.
", "default": false }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "closed", "category": "pull_request" }, "converted_to_draft": { "descriptionHtml": "A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "converted_to_draft" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "color", "description": "", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true } ] }, { "type": "object", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "active_lock_reason", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "object", "name": "assignee", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_reviewers", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_teams", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "The level of privacy this team should have
" }, { "type": "string", "name": "notification_setting", "description": "The notification setting the team has set
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "ldap_dn", "description": "Distinguished Name (DN) that team maps to within LDAP environment
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "commits", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "statuses", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "html", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comment", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "enabled_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "string", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true } ] }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
" }, { "type": "boolean", "name": "merged", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "", "isRequired": true }, { "type": "object", "name": "merged_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
", "isRequired": true }, { "type": "integer", "name": "commits", "description": "", "isRequired": true }, { "type": "integer", "name": "additions", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether to allow updating the pull request's branch.
" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged.
", "default": false }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "converted_to_draft", "category": "pull_request" }, "demilestoned": { "descriptionHtml": "A pull request was removed from a milestone.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "demilestoned" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
A collection of related issues and pull requests.
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "number", "in": "body", "description": "The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default.
", "default": false }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default.
", "default": false }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "demilestoned", "category": "pull_request" }, "edited": { "descriptionHtml": "The title or body of a pull request was edited, or the base branch of a pull request was changed.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the comment if the action was edited.
The previous version of the body if the action was edited.
The previous version of the title if the action was edited.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "color", "description": "", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true } ] }, { "type": "object", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "active_lock_reason", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "object", "name": "assignee", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_reviewers", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_teams", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "The level of privacy this team should have
" }, { "type": "string", "name": "notification_setting", "description": "The notification setting the team has set
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "ldap_dn", "description": "Distinguished Name (DN) that team maps to within LDAP environment
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "commits", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "statuses", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "html", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comment", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "enabled_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "string", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true } ] }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
" }, { "type": "boolean", "name": "merged", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "", "isRequired": true }, { "type": "object", "name": "merged_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
", "isRequired": true }, { "type": "integer", "name": "commits", "description": "", "isRequired": true }, { "type": "integer", "name": "additions", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether to allow updating the pull request's branch.
" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged.
", "default": false }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "pull_request" }, "labeled": { "descriptionHtml": "A label was added to a pull request.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "labeled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "integer", "name": "number", "in": "body", "description": "The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "labeled", "category": "pull_request" }, "locked": { "descriptionHtml": "Conversation on a pull request was locked. For more information, see \"Locking conversations.\"
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "locked" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "locked", "category": "pull_request" }, "milestoned": { "descriptionHtml": "A pull request was added to a milestone.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "milestoned" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
A collection of related issues and pull requests.
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "integer", "name": "number", "in": "body", "description": "The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default.
", "default": false }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default.
", "default": false }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "milestoned", "category": "pull_request" }, "opened": { "descriptionHtml": "A pull request was created
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "opened" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "color", "description": "", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true } ] }, { "type": "object", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "active_lock_reason", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "object", "name": "assignee", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_reviewers", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_teams", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "The level of privacy this team should have
" }, { "type": "string", "name": "notification_setting", "description": "The notification setting the team has set
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "ldap_dn", "description": "Distinguished Name (DN) that team maps to within LDAP environment
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "commits", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "statuses", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "html", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comment", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "enabled_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "string", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true } ] }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
" }, { "type": "boolean", "name": "merged", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "", "isRequired": true }, { "type": "object", "name": "merged_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
", "isRequired": true }, { "type": "integer", "name": "commits", "description": "", "isRequired": true }, { "type": "integer", "name": "additions", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether to allow updating the pull request's branch.
" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged.
", "default": false }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "opened", "category": "pull_request" }, "ready_for_review": { "descriptionHtml": "A draft pull request was marked as ready for review. For more information, see \"Changing the stage of a pull request.\"
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "ready_for_review" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "color", "description": "", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true } ] }, { "type": "object", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "active_lock_reason", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "object", "name": "assignee", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_reviewers", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_teams", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "The level of privacy this team should have
" }, { "type": "string", "name": "notification_setting", "description": "The notification setting the team has set
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "ldap_dn", "description": "Distinguished Name (DN) that team maps to within LDAP environment
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "commits", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "statuses", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "html", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comment", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "enabled_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "string", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true } ] }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
" }, { "type": "boolean", "name": "merged", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "", "isRequired": true }, { "type": "object", "name": "merged_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
", "isRequired": true }, { "type": "integer", "name": "commits", "description": "", "isRequired": true }, { "type": "integer", "name": "additions", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether to allow updating the pull request's branch.
" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged.
", "default": false }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "ready_for_review", "category": "pull_request" }, "reopened": { "descriptionHtml": "A previously closed pull request was reopened.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "reopened" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "color", "description": "", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true } ] }, { "type": "object", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ], "default": "open" }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "active_lock_reason", "description": "" }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "object", "name": "assignee", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "assignees", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_reviewers", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "array of objects or null", "name": "requested_teams", "description": "", "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "The level of privacy this team should have
" }, { "type": "string", "name": "notification_setting", "description": "The notification setting the team has set
" }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "ldap_dn", "description": "Distinguished Name (DN) that team maps to within LDAP environment
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A repository on GitHub.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "object", "name": "license", "description": "License Simple
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" } ] }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" } ] }, { "type": "object", "name": "owner", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true, "default": false }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false }, { "type": "array of strings", "name": "topics", "description": "" }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository disabled.
", "isRequired": true }, { "type": "string", "name": "visibility", "description": "The repository visibility: public, private, or internal.
", "default": "public" }, { "type": "string or null", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "string", "name": "temp_clone_token", "description": "" }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
", "default": false }, { "type": "boolean", "name": "use_squash_pr_title_as_default", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow forking this repo
" }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
", "default": false }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "boolean", "name": "anonymous_access_enabled", "description": "Whether anonymous git access is enabled for this repository
" }, { "type": "object", "name": "code_search_index_status", "description": "The status of the code search index for this repository
", "childParamsGroups": [ { "type": "boolean", "name": "lexical_search_ok", "description": "" }, { "type": "string", "name": "lexical_commit_sha", "description": "" } ] } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object", "name": "user", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "commits", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "statuses", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "html", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "issue", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comments", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "review_comment", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "Hypermedia Link
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "enabled_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "string", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true } ] }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
" }, { "type": "boolean", "name": "merged", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "", "isRequired": true }, { "type": "object", "name": "merged_by", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "integer", "name": "comments", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
", "isRequired": true }, { "type": "integer", "name": "commits", "description": "", "isRequired": true }, { "type": "integer", "name": "additions", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "", "isRequired": true }, { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_update_branch", "description": "Whether to allow updating the pull request's branch.
" }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged.
", "default": false }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reopened", "category": "pull_request" }, "review_request_removed": { "descriptionHtml": "A request for review by a person or team was removed from a pull request.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "review_request_removed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "requested_team", "in": "body", "description": "Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] } ], "availability": [ "repository", "organization", "app" ], "action": "review_request_removed", "category": "pull_request" }, "review_requested": { "descriptionHtml": "Review by a person or team was requested for a pull request. For more information, see \"Requesting a pull request review.\"
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "review_requested" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "requested_team", "in": "body", "description": "Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] } ], "availability": [ "repository", "organization", "app" ], "action": "review_requested", "category": "pull_request" }, "synchronize": { "descriptionHtml": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "synchronize" ], "childParamsGroups": [] }, { "type": "string", "name": "after", "in": "body", "description": "", "isRequired": true }, { "type": "string", "name": "before", "in": "body", "description": "", "isRequired": true }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ] }, { "type": "string", "name": "merge_commit_title", "description": "The default value for a merge commit message title.
", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ] }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "synchronize", "category": "pull_request" }, "unassigned": { "descriptionHtml": "A user was unassigned from a pull request.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unassigned" ], "childParamsGroups": [] }, { "type": "object or null", "name": "assignee", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unassigned", "category": "pull_request" }, "unlabeled": { "descriptionHtml": "A label was removed from a pull request.
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unlabeled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "integer", "name": "number", "in": "body", "description": "The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ] }, { "type": "string", "name": "merge_commit_title", "description": "The default value for a merge commit message title.
", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ] }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unlabeled", "category": "pull_request" }, "unlocked": { "descriptionHtml": "Conversation on a pull request was unlocked. For more information, see \"Locking conversations.\"
", "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unlocked" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The pull request number.
", "isRequired": true }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "integer", "name": "changed_files", "description": "" }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "comments", "description": "" }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "integer", "name": "commits", "description": "" }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "deletions", "description": "" }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "Indicates whether or not the pull request is a draft.
", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintainer_can_modify", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "mergeable", "description": "" }, { "type": "string", "name": "mergeable_state", "description": "" }, { "type": "boolean or null", "name": "merged", "description": "" }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "merged_by", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "Number uniquely identifying the pull request within its repository.
", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "boolean or null", "name": "rebaseable", "description": "" }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "integer", "name": "review_comments", "description": "" }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unlocked", "category": "pull_request" } }, "pull_request_review_comment": { "created": { "descriptionHtml": "A comment on a pull request diff was created.
", "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "comment", "in": "body", "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "pull_request_review_comment" }, "deleted": { "descriptionHtml": "A comment on a pull request diff was deleted.
", "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "comment", "in": "body", "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "pull_request_review_comment" }, "edited": { "descriptionHtml": "The content of a comment on a pull request diff was changed.
", "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the comment.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "The previous version of the body.
", "isRequired": true } ] } ] }, { "type": "object", "name": "comment", "in": "body", "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "" }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "user_view_type", "description": "" }, { "type": "string", "name": "url", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "pull_request_review_comment" } }, "pull_request_review": { "dismissed": { "descriptionHtml": "A review on a pull request was dismissed.
", "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "dismissed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The review that was affected.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "html", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "The text of the review.
", "isRequired": true }, { "type": "string", "name": "commit_id", "description": "A commit SHA for the review.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the review
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "pull_request_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "dismissed", "approved", "changes_requested" ] }, { "type": "string", "name": "submitted_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "" }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "dismissed", "category": "pull_request_review" }, "edited": { "descriptionHtml": "The body comment on a pull request review was edited.
", "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "The previous version of the body if the action was edited.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The review that was affected.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "html", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "The text of the review.
", "isRequired": true }, { "type": "string", "name": "commit_id", "description": "A commit SHA for the review.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the review
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "pull_request_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string or null", "name": "submitted_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "" }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "pull_request_review" }, "submitted": { "descriptionHtml": "A review on a pull request was submitted.
", "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "submitted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merge_commit_message", "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "squash_merge_commit_message", "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The review that was affected.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "html", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string or null", "name": "body", "description": "The text of the review.
", "isRequired": true }, { "type": "string", "name": "commit_id", "description": "A commit SHA for the review.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the review
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "pull_request_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string or null", "name": "submitted_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "" }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "submitted", "category": "pull_request_review" } }, "pull_request_review_thread": { "resolved": { "descriptionHtml": "A comment thread on a pull request was marked as resolved.
", "summaryHtml": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "resolved" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string or null", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object or null", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] }, { "type": "object", "name": "thread", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "comments", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "html", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "The text of the comment.
", "isRequired": true }, { "type": "string", "name": "commit_id", "description": "The SHA of the commit to which the comment applies.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_hunk", "description": "The diff of the line that the comment refers to.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "HTML URL for the pull request review comment.
", "isRequired": true }, { "type": "integer", "name": "id", "description": "The ID of the pull request review comment.
", "isRequired": true }, { "type": "integer", "name": "in_reply_to_id", "description": "The comment ID to reply to.
" }, { "type": "integer or null", "name": "line", "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the pull request review comment.
", "isRequired": true }, { "type": "string", "name": "original_commit_id", "description": "The SHA of the original commit to which the comment applies.
", "isRequired": true }, { "type": "integer or null", "name": "original_line", "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", "isRequired": true }, { "type": "integer", "name": "original_position", "description": "The index of the original line in the diff to which the comment applies.
", "isRequired": true }, { "type": "integer or null", "name": "original_start_line", "description": "The first line of the range for a multi-line comment.
", "isRequired": true }, { "type": "string", "name": "path", "description": "The relative path of the file to which the comment applies.
", "isRequired": true }, { "type": "integer or null", "name": "position", "description": "The line index in the diff to which the comment applies.
", "isRequired": true }, { "type": "integer or null", "name": "pull_request_review_id", "description": "The ID of the pull request review to which the comment belongs.
", "isRequired": true }, { "type": "string", "name": "pull_request_url", "description": "URL for the pull request that the review comment belongs to.
", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "side", "description": "The side of the first line of the range for a multi-line comment.
", "isRequired": true, "enum": [ "LEFT", "RIGHT" ] }, { "type": "integer or null", "name": "start_line", "description": "The first line of the range for a multi-line comment.
", "isRequired": true }, { "type": "string or null", "name": "start_side", "description": "The side of the first line of the range for a multi-line comment.
", "isRequired": true, "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, { "type": "string", "name": "subject_type", "description": "The level at which the comment is targeted, can be a diff line or a file.
", "enum": [ "line", "file" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the pull request review comment
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization", "Mannequin" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "updated_at", "in": "body", "description": "" } ], "availability": [ "repository", "organization", "app" ], "action": "resolved", "category": "pull_request_review_thread" }, "unresolved": { "descriptionHtml": "A previously resolved comment thread on a pull request was marked as unresolved.
", "summaryHtml": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unresolved" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "object or null", "name": "auto_merge", "description": "The status of auto merging a pull request.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "commit_message", "description": "Commit message for the merge commit.
", "isRequired": true }, { "type": "string", "name": "commit_title", "description": "Title for the merge commit message.
", "isRequired": true }, { "type": "object or null", "name": "enabled_by", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "merge_method", "description": "The merge method to use.
", "isRequired": true, "enum": [ "merge", "squash", "rebase" ] } ] }, { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "draft", "description": "", "isRequired": true }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "A git repository
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "allow_auto_merge", "description": "Whether to allow auto-merge for pull requests.
", "default": false }, { "type": "boolean", "name": "allow_forking", "description": "Whether to allow private forks
" }, { "type": "boolean", "name": "allow_merge_commit", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_squash_merge", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_update_branch", "description": "" }, { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "archived", "description": "Whether the repository is archived.
", "isRequired": true, "default": false }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "integer or string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "default_branch", "description": "The default branch of the repository.
", "isRequired": true }, { "type": "boolean", "name": "delete_branch_on_merge", "description": "Whether to delete head branches when pull requests are merged
", "default": false }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "boolean", "name": "disabled", "description": "Returns whether or not this repository is disabled.
" }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "integer", "name": "forks", "description": "", "isRequired": true }, { "type": "integer", "name": "forks_count", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_downloads", "description": "Whether downloads are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_issues", "description": "Whether issues are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_pages", "description": "", "isRequired": true }, { "type": "boolean", "name": "has_projects", "description": "Whether projects are enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_wiki", "description": "Whether the wiki is enabled.
", "isRequired": true, "default": true }, { "type": "boolean", "name": "has_discussions", "description": "Whether discussions are enabled.
", "isRequired": true, "default": false }, { "type": "string or null", "name": "homepage", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "boolean", "name": "is_template", "description": "" }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "language", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "license", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "key", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "spdx_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "master_branch", "description": "" }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "mirror_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "integer", "name": "open_issues_count", "description": "", "isRequired": true }, { "type": "string", "name": "organization", "description": "" }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "permissions", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "admin", "description": "", "isRequired": true }, { "type": "boolean", "name": "maintain", "description": "" }, { "type": "boolean", "name": "pull", "description": "", "isRequired": true }, { "type": "boolean", "name": "push", "description": "", "isRequired": true }, { "type": "boolean", "name": "triage", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "boolean", "name": "public", "description": "" }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "null or integer or string", "name": "pushed_at", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "role_name", "description": "" }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string", "name": "ssh_url", "description": "", "isRequired": true }, { "type": "integer", "name": "stargazers", "description": "" }, { "type": "integer", "name": "stargazers_count", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "svn_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "array of strings", "name": "topics", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "visibility", "description": "", "isRequired": true, "enum": [ "public", "private", "internal" ] }, { "type": "integer", "name": "watchers", "description": "", "isRequired": true }, { "type": "integer", "name": "watchers_count", "description": "", "isRequired": true }, { "type": "boolean", "name": "web_commit_signoff_required", "description": "Whether to require contributors to sign off on web-based commits
" } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issue_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "labels", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "color", "description": "6-character hex code, without the leading #, identifying the color
", "isRequired": true }, { "type": "boolean", "name": "default", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the label.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the label
", "isRequired": true } ] }, { "type": "boolean", "name": "locked", "description": "", "isRequired": true }, { "type": "string or null", "name": "merge_commit_sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "merged_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "milestone", "description": "A collection of related issues and pull requests.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string or null", "name": "due_on", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "The number of the milestone.
", "isRequired": true }, { "type": "integer", "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "The state of the milestone.
", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "title", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "patch_url", "description": "", "isRequired": true }, { "type": "array", "name": "requested_reviewers", "description": "", "isRequired": true }, { "type": "array of objects", "name": "requested_teams", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" } ] }, { "type": "string", "name": "review_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open", "closed" ] }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "title", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] }, { "type": "object", "name": "thread", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "comments", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "_links", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "html", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "pull_request", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] }, { "type": "object", "name": "self", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "href", "description": "", "isRequired": true } ] } ] }, { "type": "string", "name": "author_association", "description": "How the author is associated with the repository.
", "isRequired": true, "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, { "type": "string", "name": "body", "description": "The text of the comment.
", "isRequired": true }, { "type": "string", "name": "commit_id", "description": "The SHA of the commit to which the comment applies.
", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "diff_hunk", "description": "The diff of the line that the comment refers to.
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "HTML URL for the pull request review comment.
", "isRequired": true }, { "type": "integer", "name": "id", "description": "The ID of the pull request review comment.
", "isRequired": true }, { "type": "integer", "name": "in_reply_to_id", "description": "The comment ID to reply to.
" }, { "type": "integer or null", "name": "line", "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "The node ID of the pull request review comment.
", "isRequired": true }, { "type": "string", "name": "original_commit_id", "description": "The SHA of the original commit to which the comment applies.
", "isRequired": true }, { "type": "integer", "name": "original_line", "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", "isRequired": true }, { "type": "integer", "name": "original_position", "description": "The index of the original line in the diff to which the comment applies.
", "isRequired": true }, { "type": "integer or null", "name": "original_start_line", "description": "The first line of the range for a multi-line comment.
", "isRequired": true }, { "type": "string", "name": "path", "description": "The relative path of the file to which the comment applies.
", "isRequired": true }, { "type": "integer or null", "name": "position", "description": "The line index in the diff to which the comment applies.
", "isRequired": true }, { "type": "integer or null", "name": "pull_request_review_id", "description": "The ID of the pull request review to which the comment belongs.
", "isRequired": true }, { "type": "string", "name": "pull_request_url", "description": "URL for the pull request that the review comment belongs to.
", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "side", "description": "The side of the first line of the range for a multi-line comment.
", "isRequired": true, "enum": [ "LEFT", "RIGHT" ] }, { "type": "integer or null", "name": "start_line", "description": "The first line of the range for a multi-line comment.
", "isRequired": true }, { "type": "string or null", "name": "start_side", "description": "The side of the first line of the range for a multi-line comment.
", "isRequired": true, "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, { "type": "string", "name": "subject_type", "description": "The level at which the comment is targeted, can be a diff line or a file.
", "enum": [ "line", "file" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the pull request review comment
", "isRequired": true }, { "type": "object or null", "name": "user", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "updated_at", "in": "body", "description": "" } ], "availability": [ "repository", "organization", "app" ], "action": "unresolved", "category": "pull_request_review_thread" } }, "push": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nThe SHA of the most recent commit on ref after the push.
The SHA of the most recent commit on ref before the push.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 2048 commits. If necessary, you can use the Commits API to fetch additional commits.
An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.
" }, { "type": "object", "name": "author", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "object", "name": "committer", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "boolean", "name": "distinct", "description": "Whether this commit is distinct from any that have been pushed before.
", "isRequired": true }, { "type": "string", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "message", "description": "The commit message.
", "isRequired": true }, { "type": "array of strings", "name": "modified", "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.
" }, { "type": "array of strings", "name": "removed", "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.
" }, { "type": "string", "name": "timestamp", "description": "The ISO 8601 timestamp of the commit.
", "isRequired": true }, { "type": "string", "name": "tree_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL that points to the commit API resource.
", "isRequired": true } ] }, { "type": "string", "name": "compare", "in": "body", "description": "URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit.
Whether this push created the ref.
Whether this push deleted the ref.
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.\"
Whether this push was a force push of the ref.
An array of files added in the commit.
" }, { "type": "object", "name": "author", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "object", "name": "committer", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "boolean", "name": "distinct", "description": "Whether this commit is distinct from any that have been pushed before.
", "isRequired": true }, { "type": "string", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "message", "description": "The commit message.
", "isRequired": true }, { "type": "array of strings", "name": "modified", "description": "An array of files modified by the commit.
" }, { "type": "array of strings", "name": "removed", "description": "An array of files removed in the commit.
" }, { "type": "string", "name": "timestamp", "description": "The ISO 8601 timestamp of the commit.
", "isRequired": true }, { "type": "string", "name": "tree_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL that points to the commit API resource.
", "isRequired": true } ] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "string", "name": "ref", "in": "body", "description": "The full git ref that was pushed. Example: refs/heads/main or refs/tags/v3.14.1.
A git repository
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "push" } }, "registry_package": { "published": { "descriptionHtml": "A package was published to a registry.
", "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "published", "category": "registry_package" }, "updated": { "descriptionHtml": "A package that was previously published to a registry was updated.
", "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "updated", "category": "registry_package" } }, "release": { "created": { "descriptionHtml": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.
", "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The release object.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assets", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "browser_download_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_type", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "download_count", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The file name of the asset.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string or null", "name": "digest", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the release asset.
", "isRequired": true, "enum": [ "uploaded" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "uploader", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "assets_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "discussion_url", "description": "" }, { "type": "boolean", "name": "draft", "description": "Whether the release is a draft or published
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "immutable", "description": "Whether or not the release is immutable.
", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "Whether the release is identified as a prerelease or a full release.
", "isRequired": true }, { "type": "string or null", "name": "published_at", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "tag_name", "description": "The name of the tag.
", "isRequired": true }, { "type": "string or null", "name": "tarball_url", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "Specifies the commitish value that determines where the Git tag is created from.
", "isRequired": true }, { "type": "string", "name": "upload_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "zipball_url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "release" }, "deleted": { "descriptionHtml": "A release, pre-release, or draft release was deleted.
", "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The release object.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assets", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "browser_download_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_type", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "download_count", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The file name of the asset.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string or null", "name": "digest", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the release asset.
", "isRequired": true, "enum": [ "uploaded" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "uploader", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "assets_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "discussion_url", "description": "" }, { "type": "boolean", "name": "draft", "description": "Whether the release is a draft or published
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "immutable", "description": "Whether or not the release is immutable.
", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "Whether the release is identified as a prerelease or a full release.
", "isRequired": true }, { "type": "string or null", "name": "published_at", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "tag_name", "description": "The name of the tag.
", "isRequired": true }, { "type": "string or null", "name": "tarball_url", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "Specifies the commitish value that determines where the Git tag is created from.
", "isRequired": true }, { "type": "string", "name": "upload_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "zipball_url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "release" }, "edited": { "descriptionHtml": "The details of a release, pre-release, or draft release were edited. For more information, see \"Managing releases in a repository.\"
", "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "The previous version of the body if the action was edited.
The previous version of the name if the action was edited.
The previous version of the tag_name if the action was edited.
Whether this release was explicitly edited to be the latest.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The release object.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assets", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "browser_download_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_type", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "download_count", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The file name of the asset.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string or null", "name": "digest", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the release asset.
", "isRequired": true, "enum": [ "uploaded" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "uploader", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "assets_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "discussion_url", "description": "" }, { "type": "boolean", "name": "draft", "description": "Whether the release is a draft or published
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "immutable", "description": "Whether or not the release is immutable.
", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "Whether the release is identified as a prerelease or a full release.
", "isRequired": true }, { "type": "string or null", "name": "published_at", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "tag_name", "description": "The name of the tag.
", "isRequired": true }, { "type": "string or null", "name": "tarball_url", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "Specifies the commitish value that determines where the Git tag is created from.
", "isRequired": true }, { "type": "string", "name": "upload_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "zipball_url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "release" }, "prereleased": { "descriptionHtml": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.
", "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "prereleased" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The release object.
", "isRequired": true, "childParamsGroups": [ { "type": "array of object,nulls", "name": "assets", "description": "", "isRequired": true }, { "type": "string", "name": "assets_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "discussion_url", "description": "" }, { "type": "boolean", "name": "draft", "description": "Whether the release is a draft or published
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "immutable", "description": "Whether or not the release is immutable.
", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "Whether the release is identified as a prerelease or a full release.
", "isRequired": true, "enum": [ true ] }, { "type": "string or null", "name": "published_at", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "tag_name", "description": "The name of the tag.
", "isRequired": true }, { "type": "string or null", "name": "tarball_url", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "Specifies the commitish value that determines where the Git tag is created from.
", "isRequired": true }, { "type": "string", "name": "upload_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "zipball_url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "prereleased", "category": "release" }, "published": { "descriptionHtml": "A release, pre-release, or draft of a release was published.
", "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "published" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The release object.
", "isRequired": true, "childParamsGroups": [ { "type": "array of object,nulls", "name": "assets", "description": "", "isRequired": true }, { "type": "string", "name": "assets_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "discussion_url", "description": "" }, { "type": "boolean", "name": "draft", "description": "Whether the release is a draft or published
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "immutable", "description": "Whether or not the release is immutable.
", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "Whether the release is identified as a prerelease or a full release.
", "isRequired": true }, { "type": "string or null", "name": "published_at", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "tag_name", "description": "The name of the tag.
", "isRequired": true }, { "type": "string or null", "name": "tarball_url", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "Specifies the commitish value that determines where the Git tag is created from.
", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "upload_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "zipball_url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "published", "category": "release" }, "released": { "descriptionHtml": "A release was published, or a pre-release was changed to a release.
", "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "released" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The release object.
", "isRequired": true, "childParamsGroups": [ { "type": "array of objects", "name": "assets", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "browser_download_url", "description": "", "isRequired": true }, { "type": "string", "name": "content_type", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", "name": "download_count", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string or null", "name": "label", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The file name of the asset.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "size", "description": "", "isRequired": true }, { "type": "string or null", "name": "digest", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "State of the release asset.
", "isRequired": true, "enum": [ "uploaded" ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "uploader", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "assets_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "discussion_url", "description": "" }, { "type": "boolean", "name": "draft", "description": "Whether the release is a draft or published
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "immutable", "description": "Whether or not the release is immutable.
", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "Whether the release is identified as a prerelease or a full release.
", "isRequired": true }, { "type": "string or null", "name": "published_at", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "tag_name", "description": "The name of the tag.
", "isRequired": true }, { "type": "string or null", "name": "tarball_url", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "Specifies the commitish value that determines where the Git tag is created from.
", "isRequired": true }, { "type": "string", "name": "upload_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "zipball_url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "released", "category": "release" }, "unpublished": { "descriptionHtml": "A release or pre-release was unpublished.
", "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unpublished" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The release object.
", "isRequired": true, "childParamsGroups": [ { "type": "array of object,nulls", "name": "assets", "description": "", "isRequired": true }, { "type": "string", "name": "assets_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "discussion_url", "description": "" }, { "type": "boolean", "name": "draft", "description": "Whether the release is a draft or published
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "boolean", "name": "immutable", "description": "Whether or not the release is immutable.
", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "boolean", "name": "prerelease", "description": "Whether the release is identified as a prerelease or a full release.
", "isRequired": true }, { "type": "string or null", "name": "published_at", "description": "", "isRequired": true }, { "type": "object", "name": "reactions", "description": "", "childParamsGroups": [ { "type": "integer", "name": "+1", "description": "", "isRequired": true }, { "type": "integer", "name": "-1", "description": "", "isRequired": true }, { "type": "integer", "name": "confused", "description": "", "isRequired": true }, { "type": "integer", "name": "eyes", "description": "", "isRequired": true }, { "type": "integer", "name": "heart", "description": "", "isRequired": true }, { "type": "integer", "name": "hooray", "description": "", "isRequired": true }, { "type": "integer", "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", "name": "total_count", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "tag_name", "description": "The name of the tag.
", "isRequired": true }, { "type": "string or null", "name": "tarball_url", "description": "", "isRequired": true }, { "type": "string", "name": "target_commitish", "description": "Specifies the commitish value that determines where the Git tag is created from.
", "isRequired": true }, { "type": "string or null", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "upload_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string or null", "name": "zipball_url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "unpublished", "category": "release" } }, "repository": { "anonymous_access_disabled": { "descriptionHtml": "Someone disabled anonymous Git read access to the repository. For more information, see \"Enabling anonymous Git read access for a repository.\"
", "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "anonymous_access_disabled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "app", "business", "organization", "repository" ], "action": "anonymous_access_disabled", "category": "repository" }, "anonymous_access_enabled": { "descriptionHtml": "Someone enabled anonymous Git read access to the repository. For more information, see \"Enabling anonymous Git read access for a repository.\"
", "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "anonymous_access_enabled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "app", "business", "organization", "repository" ], "action": "anonymous_access_enabled", "category": "repository" }, "archived": { "descriptionHtml": "A repository was archived.
", "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "archived" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "archived", "category": "repository" }, "created": { "descriptionHtml": "A repository was created.
", "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "created", "category": "repository" }, "deleted": { "descriptionHtml": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.
", "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "deleted", "category": "repository" }, "edited": { "descriptionHtml": "The topics, default branch, description, or homepage of a repository was changed.
", "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "default_branch", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "", "isRequired": true } ] }, { "type": "object", "name": "description", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "from", "description": "", "isRequired": true } ] }, { "type": "object", "name": "homepage", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "from", "description": "", "isRequired": true } ] }, { "type": "object", "name": "topics", "description": "", "childParamsGroups": [ { "type": "array of strings or null", "name": "from", "description": "" } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "edited", "category": "repository" }, "privatized": { "descriptionHtml": "The visibility of a repository was changed to private.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "privatized" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "privatized", "category": "repository" }, "publicized": { "descriptionHtml": "The visibility of a repository was changed to public.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "publicized" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "publicized", "category": "repository" }, "renamed": { "descriptionHtml": "The name of a repository was changed.
", "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "renamed" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "repository", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "name", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "from", "description": "", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "renamed", "category": "repository" }, "transferred": { "descriptionHtml": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "transferred" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "from", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "organization", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "public_members_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "user", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ] } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "transferred", "category": "repository" }, "unarchived": { "descriptionHtml": "A previously archived repository was unarchived.
", "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "unarchived" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "unarchived", "category": "repository" } }, "repository_dispatch": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when a GitHub App sends a POST request to /repos/{owner}/{repo}/dispatches. For more information, see the REST API documentation for creating a repository dispatch event. In the payload, the action will be the event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "The event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.
The client_payload that was specified in the POST /repos/{owner}/{repo}/dispatches request body.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "app" ], "action": "default", "category": "repository_dispatch" } }, "repository_ruleset": { "created": { "descriptionHtml": "A repository ruleset was created.
", "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A set of rules to apply when specified conditions are met.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the ruleset
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the ruleset
", "isRequired": true }, { "type": "string", "name": "target", "description": "The target of the ruleset.
", "enum": [ "branch", "tag", "push" ] }, { "type": "string", "name": "source_type", "description": "The type of the source of the ruleset
", "enum": [ "Repository", "Organization" ] }, { "type": "string", "name": "source", "description": "The name of the source
", "isRequired": true }, { "type": "string", "name": "enforcement", "description": "The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.
The actors that can bypass the rules in this ruleset
", "childParamsGroups": [ { "type": "integer or null", "name": "actor_id", "description": "The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.
The type of actor that can bypass a ruleset
", "isRequired": true, "enum": [ "Integration", "OrganizationAdmin", "RepositoryRole", "Team", "DeployKey", "EnterpriseOwner" ] }, { "type": "string", "name": "bypass_mode", "description": "When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.
The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.
", "enum": [ "always", "pull_requests_only", "never" ] }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object", "name": "_links", "description": "", "childParamsGroups": [ { "type": "object", "name": "self", "description": "", "childParamsGroups": [ { "type": "string", "name": "href", "description": "The URL of the ruleset
" } ] }, { "type": "object or null", "name": "html", "description": "", "childParamsGroups": [ { "type": "string", "name": "href", "description": "The html URL of the ruleset
" } ] } ] }, { "type": "null or object", "name": "conditions", "description": "" }, { "type": "array of objects", "name": "rules", "description": "", "childParamsGroups": [ { "type": "object", "name": "creation", "description": "Only allow users with bypass permission to create matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "creation" ] } ] }, { "type": "object", "name": "update", "description": "Only allow users with bypass permission to update matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "update" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "update_allows_fetch_and_merge", "description": "Branch can pull changes from its upstream repository
", "isRequired": true } ] } ] }, { "type": "object", "name": "deletion", "description": "Only allow users with bypass permissions to delete matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "deletion" ] } ] }, { "type": "object", "name": "required_linear_history", "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_linear_history" ] } ] }, { "type": "object", "name": "merge_queue", "description": "Merges must be performed via a merge queue.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "merge_queue" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "check_response_timeout_minutes", "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", "isRequired": true }, { "type": "string", "name": "grouping_strategy", "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", "isRequired": true, "enum": [ "ALLGREEN", "HEADGREEN" ] }, { "type": "integer", "name": "max_entries_to_build", "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", "isRequired": true }, { "type": "integer", "name": "max_entries_to_merge", "description": "The maximum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "string", "name": "merge_method", "description": "Method to use when merging changes from queued pull requests.
", "isRequired": true, "enum": [ "MERGE", "SQUASH", "REBASE" ] }, { "type": "integer", "name": "min_entries_to_merge", "description": "The minimum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "integer", "name": "min_entries_to_merge_wait_minutes", "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_deployments", "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_deployments" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "required_deployment_environments", "description": "The environments that must be successfully deployed to before branches can be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_signatures", "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_signatures" ] } ] }, { "type": "object", "name": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "pull_request" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "allowed_merge_methods", "description": "Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.\nSupported values are: merge, squash, rebase
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" }, { "type": "boolean", "name": "dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.
", "isRequired": true }, { "type": "boolean", "name": "require_code_owner_review", "description": "Require an approving review in pull requests that modify files that have a designated code owner.
", "isRequired": true }, { "type": "boolean", "name": "require_last_push_approval", "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
", "isRequired": true }, { "type": "integer", "name": "required_approving_review_count", "description": "The number of approving reviews that are required before a pull request can be merged.
", "isRequired": true }, { "type": "boolean", "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true }, { "type": "array of objects", "name": "required_reviewers", "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", "childParamsGroups": [ { "type": "array of strings", "name": "file_patterns", "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", "isRequired": true }, { "type": "integer", "name": "minimum_approvals", "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", "isRequired": true }, { "type": "object", "name": "reviewer", "description": "A required reviewing team
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "ID of the reviewer which must review changes to matching files.
", "isRequired": true }, { "type": "string", "name": "type", "description": "The type of the reviewer
", "isRequired": true, "enum": [ "Team" ] } ] } ] } ] } ] }, { "type": "object", "name": "required_status_checks", "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_status_checks" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "required_status_checks", "description": "Status checks that are required.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "context", "description": "The status check context name that must be present on the commit.
", "isRequired": true }, { "type": "integer", "name": "integration_id", "description": "The optional integration ID that this status check must originate from.
" } ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
", "isRequired": true } ] } ] }, { "type": "object", "name": "non_fast_forward", "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "non_fast_forward" ] } ] }, { "type": "object", "name": "commit_message_pattern", "description": "Parameters to be used for the commit_message_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_message_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "commit_author_email_pattern", "description": "Parameters to be used for the commit_author_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_author_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "committer_email_pattern", "description": "Parameters to be used for the committer_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "committer_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "branch_name_pattern", "description": "Parameters to be used for the branch_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "branch_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "tag_name_pattern", "description": "Parameters to be used for the tag_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "tag_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_path_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_paths", "description": "The file paths that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_path_length", "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_path_length" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_path_length", "description": "The maximum amount of characters allowed in file paths.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_extension_restriction", "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_extension_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_extensions", "description": "The file extensions that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_size", "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_size" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_size", "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
", "isRequired": true } ] } ] }, { "type": "object", "name": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "workflows" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "workflows", "description": "Workflows that must pass for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "path", "description": "The path to the workflow file
", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref (branch or tag) of the workflow file to use
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository where the workflow is defined
", "isRequired": true }, { "type": "string", "name": "sha", "description": "The commit SHA of the workflow file to use
" } ] } ] } ] }, { "type": "object", "name": "code_scanning", "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "code_scanning" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of objects", "name": "code_scanning_tools", "description": "Tools that must provide code scanning results for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "alerts_threshold", "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "errors", "errors_and_warnings", "all" ] }, { "type": "string", "name": "security_alerts_threshold", "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "critical", "high_or_higher", "medium_or_higher", "all" ] }, { "type": "string", "name": "tool", "description": "The name of a code scanning tool
", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "copilot_code_review", "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "copilot_code_review" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "review_draft_pull_requests", "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" }, { "type": "boolean", "name": "review_on_push", "description": "Copilot automatically reviews each new push to the pull request.
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string", "name": "updated_at", "description": "" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "repository_ruleset" }, "deleted": { "descriptionHtml": "A repository ruleset was deleted.
", "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A set of rules to apply when specified conditions are met.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the ruleset
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the ruleset
", "isRequired": true }, { "type": "string", "name": "target", "description": "The target of the ruleset.
", "enum": [ "branch", "tag", "push" ] }, { "type": "string", "name": "source_type", "description": "The type of the source of the ruleset
", "enum": [ "Repository", "Organization" ] }, { "type": "string", "name": "source", "description": "The name of the source
", "isRequired": true }, { "type": "string", "name": "enforcement", "description": "The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.
The actors that can bypass the rules in this ruleset
", "childParamsGroups": [ { "type": "integer or null", "name": "actor_id", "description": "The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.
The type of actor that can bypass a ruleset
", "isRequired": true, "enum": [ "Integration", "OrganizationAdmin", "RepositoryRole", "Team", "DeployKey", "EnterpriseOwner" ] }, { "type": "string", "name": "bypass_mode", "description": "When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.
The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.
", "enum": [ "always", "pull_requests_only", "never" ] }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object", "name": "_links", "description": "", "childParamsGroups": [ { "type": "object", "name": "self", "description": "", "childParamsGroups": [ { "type": "string", "name": "href", "description": "The URL of the ruleset
" } ] }, { "type": "object or null", "name": "html", "description": "", "childParamsGroups": [ { "type": "string", "name": "href", "description": "The html URL of the ruleset
" } ] } ] }, { "type": "null or object", "name": "conditions", "description": "" }, { "type": "array of objects", "name": "rules", "description": "", "childParamsGroups": [ { "type": "object", "name": "creation", "description": "Only allow users with bypass permission to create matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "creation" ] } ] }, { "type": "object", "name": "update", "description": "Only allow users with bypass permission to update matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "update" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "update_allows_fetch_and_merge", "description": "Branch can pull changes from its upstream repository
", "isRequired": true } ] } ] }, { "type": "object", "name": "deletion", "description": "Only allow users with bypass permissions to delete matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "deletion" ] } ] }, { "type": "object", "name": "required_linear_history", "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_linear_history" ] } ] }, { "type": "object", "name": "merge_queue", "description": "Merges must be performed via a merge queue.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "merge_queue" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "check_response_timeout_minutes", "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", "isRequired": true }, { "type": "string", "name": "grouping_strategy", "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", "isRequired": true, "enum": [ "ALLGREEN", "HEADGREEN" ] }, { "type": "integer", "name": "max_entries_to_build", "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", "isRequired": true }, { "type": "integer", "name": "max_entries_to_merge", "description": "The maximum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "string", "name": "merge_method", "description": "Method to use when merging changes from queued pull requests.
", "isRequired": true, "enum": [ "MERGE", "SQUASH", "REBASE" ] }, { "type": "integer", "name": "min_entries_to_merge", "description": "The minimum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "integer", "name": "min_entries_to_merge_wait_minutes", "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_deployments", "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_deployments" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "required_deployment_environments", "description": "The environments that must be successfully deployed to before branches can be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_signatures", "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_signatures" ] } ] }, { "type": "object", "name": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "pull_request" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "allowed_merge_methods", "description": "Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.\nSupported values are: merge, squash, rebase
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" }, { "type": "boolean", "name": "dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.
", "isRequired": true }, { "type": "boolean", "name": "require_code_owner_review", "description": "Require an approving review in pull requests that modify files that have a designated code owner.
", "isRequired": true }, { "type": "boolean", "name": "require_last_push_approval", "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
", "isRequired": true }, { "type": "integer", "name": "required_approving_review_count", "description": "The number of approving reviews that are required before a pull request can be merged.
", "isRequired": true }, { "type": "boolean", "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true }, { "type": "array of objects", "name": "required_reviewers", "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", "childParamsGroups": [ { "type": "array of strings", "name": "file_patterns", "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", "isRequired": true }, { "type": "integer", "name": "minimum_approvals", "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", "isRequired": true }, { "type": "object", "name": "reviewer", "description": "A required reviewing team
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "ID of the reviewer which must review changes to matching files.
", "isRequired": true }, { "type": "string", "name": "type", "description": "The type of the reviewer
", "isRequired": true, "enum": [ "Team" ] } ] } ] } ] } ] }, { "type": "object", "name": "required_status_checks", "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_status_checks" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "required_status_checks", "description": "Status checks that are required.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "context", "description": "The status check context name that must be present on the commit.
", "isRequired": true }, { "type": "integer", "name": "integration_id", "description": "The optional integration ID that this status check must originate from.
" } ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
", "isRequired": true } ] } ] }, { "type": "object", "name": "non_fast_forward", "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "non_fast_forward" ] } ] }, { "type": "object", "name": "commit_message_pattern", "description": "Parameters to be used for the commit_message_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_message_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "commit_author_email_pattern", "description": "Parameters to be used for the commit_author_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_author_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "committer_email_pattern", "description": "Parameters to be used for the committer_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "committer_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "branch_name_pattern", "description": "Parameters to be used for the branch_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "branch_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "tag_name_pattern", "description": "Parameters to be used for the tag_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "tag_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_path_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_paths", "description": "The file paths that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_path_length", "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_path_length" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_path_length", "description": "The maximum amount of characters allowed in file paths.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_extension_restriction", "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_extension_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_extensions", "description": "The file extensions that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_size", "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_size" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_size", "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
", "isRequired": true } ] } ] }, { "type": "object", "name": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "workflows" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "workflows", "description": "Workflows that must pass for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "path", "description": "The path to the workflow file
", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref (branch or tag) of the workflow file to use
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository where the workflow is defined
", "isRequired": true }, { "type": "string", "name": "sha", "description": "The commit SHA of the workflow file to use
" } ] } ] } ] }, { "type": "object", "name": "code_scanning", "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "code_scanning" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of objects", "name": "code_scanning_tools", "description": "Tools that must provide code scanning results for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "alerts_threshold", "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "errors", "errors_and_warnings", "all" ] }, { "type": "string", "name": "security_alerts_threshold", "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "critical", "high_or_higher", "medium_or_higher", "all" ] }, { "type": "string", "name": "tool", "description": "The name of a code scanning tool
", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "copilot_code_review", "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "copilot_code_review" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "review_draft_pull_requests", "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" }, { "type": "boolean", "name": "review_on_push", "description": "Copilot automatically reviews each new push to the pull request.
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string", "name": "updated_at", "description": "" } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "deleted", "category": "repository_ruleset" }, "edited": { "descriptionHtml": "A repository ruleset was edited.
", "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A set of rules to apply when specified conditions are met.
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "The ID of the ruleset
", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the ruleset
", "isRequired": true }, { "type": "string", "name": "target", "description": "The target of the ruleset.
", "enum": [ "branch", "tag", "push" ] }, { "type": "string", "name": "source_type", "description": "The type of the source of the ruleset
", "enum": [ "Repository", "Organization" ] }, { "type": "string", "name": "source", "description": "The name of the source
", "isRequired": true }, { "type": "string", "name": "enforcement", "description": "The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.
The actors that can bypass the rules in this ruleset
", "childParamsGroups": [ { "type": "integer or null", "name": "actor_id", "description": "The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.
The type of actor that can bypass a ruleset
", "isRequired": true, "enum": [ "Integration", "OrganizationAdmin", "RepositoryRole", "Team", "DeployKey", "EnterpriseOwner" ] }, { "type": "string", "name": "bypass_mode", "description": "When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.
The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.
", "enum": [ "always", "pull_requests_only", "never" ] }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object", "name": "_links", "description": "", "childParamsGroups": [ { "type": "object", "name": "self", "description": "", "childParamsGroups": [ { "type": "string", "name": "href", "description": "The URL of the ruleset
" } ] }, { "type": "object or null", "name": "html", "description": "", "childParamsGroups": [ { "type": "string", "name": "href", "description": "The html URL of the ruleset
" } ] } ] }, { "type": "null or object", "name": "conditions", "description": "" }, { "type": "array of objects", "name": "rules", "description": "", "childParamsGroups": [ { "type": "object", "name": "creation", "description": "Only allow users with bypass permission to create matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "creation" ] } ] }, { "type": "object", "name": "update", "description": "Only allow users with bypass permission to update matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "update" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "update_allows_fetch_and_merge", "description": "Branch can pull changes from its upstream repository
", "isRequired": true } ] } ] }, { "type": "object", "name": "deletion", "description": "Only allow users with bypass permissions to delete matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "deletion" ] } ] }, { "type": "object", "name": "required_linear_history", "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_linear_history" ] } ] }, { "type": "object", "name": "merge_queue", "description": "Merges must be performed via a merge queue.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "merge_queue" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "check_response_timeout_minutes", "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", "isRequired": true }, { "type": "string", "name": "grouping_strategy", "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", "isRequired": true, "enum": [ "ALLGREEN", "HEADGREEN" ] }, { "type": "integer", "name": "max_entries_to_build", "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", "isRequired": true }, { "type": "integer", "name": "max_entries_to_merge", "description": "The maximum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "string", "name": "merge_method", "description": "Method to use when merging changes from queued pull requests.
", "isRequired": true, "enum": [ "MERGE", "SQUASH", "REBASE" ] }, { "type": "integer", "name": "min_entries_to_merge", "description": "The minimum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "integer", "name": "min_entries_to_merge_wait_minutes", "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_deployments", "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_deployments" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "required_deployment_environments", "description": "The environments that must be successfully deployed to before branches can be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_signatures", "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_signatures" ] } ] }, { "type": "object", "name": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "pull_request" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "allowed_merge_methods", "description": "Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.\nSupported values are: merge, squash, rebase
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" }, { "type": "boolean", "name": "dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.
", "isRequired": true }, { "type": "boolean", "name": "require_code_owner_review", "description": "Require an approving review in pull requests that modify files that have a designated code owner.
", "isRequired": true }, { "type": "boolean", "name": "require_last_push_approval", "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
", "isRequired": true }, { "type": "integer", "name": "required_approving_review_count", "description": "The number of approving reviews that are required before a pull request can be merged.
", "isRequired": true }, { "type": "boolean", "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true }, { "type": "array of objects", "name": "required_reviewers", "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", "childParamsGroups": [ { "type": "array of strings", "name": "file_patterns", "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", "isRequired": true }, { "type": "integer", "name": "minimum_approvals", "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", "isRequired": true }, { "type": "object", "name": "reviewer", "description": "A required reviewing team
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "ID of the reviewer which must review changes to matching files.
", "isRequired": true }, { "type": "string", "name": "type", "description": "The type of the reviewer
", "isRequired": true, "enum": [ "Team" ] } ] } ] } ] } ] }, { "type": "object", "name": "required_status_checks", "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_status_checks" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "required_status_checks", "description": "Status checks that are required.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "context", "description": "The status check context name that must be present on the commit.
", "isRequired": true }, { "type": "integer", "name": "integration_id", "description": "The optional integration ID that this status check must originate from.
" } ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
", "isRequired": true } ] } ] }, { "type": "object", "name": "non_fast_forward", "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "non_fast_forward" ] } ] }, { "type": "object", "name": "commit_message_pattern", "description": "Parameters to be used for the commit_message_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_message_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "commit_author_email_pattern", "description": "Parameters to be used for the commit_author_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_author_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "committer_email_pattern", "description": "Parameters to be used for the committer_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "committer_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "branch_name_pattern", "description": "Parameters to be used for the branch_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "branch_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "tag_name_pattern", "description": "Parameters to be used for the tag_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "tag_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_path_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_paths", "description": "The file paths that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_path_length", "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_path_length" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_path_length", "description": "The maximum amount of characters allowed in file paths.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_extension_restriction", "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_extension_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_extensions", "description": "The file extensions that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_size", "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_size" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_size", "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
", "isRequired": true } ] } ] }, { "type": "object", "name": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "workflows" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "workflows", "description": "Workflows that must pass for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "path", "description": "The path to the workflow file
", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref (branch or tag) of the workflow file to use
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository where the workflow is defined
", "isRequired": true }, { "type": "string", "name": "sha", "description": "The commit SHA of the workflow file to use
" } ] } ] } ] }, { "type": "object", "name": "code_scanning", "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "code_scanning" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of objects", "name": "code_scanning_tools", "description": "Tools that must provide code scanning results for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "alerts_threshold", "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "errors", "errors_and_warnings", "all" ] }, { "type": "string", "name": "security_alerts_threshold", "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "critical", "high_or_higher", "medium_or_higher", "all" ] }, { "type": "string", "name": "tool", "description": "The name of a code scanning tool
", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "copilot_code_review", "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "copilot_code_review" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "review_draft_pull_requests", "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" }, { "type": "boolean", "name": "review_on_push", "description": "Copilot automatically reviews each new push to the pull request.
" } ] } ] } ], "oneOfObject": true }, { "type": "string", "name": "created_at", "description": "" }, { "type": "string", "name": "updated_at", "description": "" } ] }, { "type": "object", "name": "changes", "in": "body", "description": "", "childParamsGroups": [ { "type": "object", "name": "name", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "" } ] }, { "type": "object", "name": "enforcement", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "" } ] }, { "type": "object", "name": "conditions", "description": "", "childParamsGroups": [ { "type": "array of objects", "name": "added", "description": "", "childParamsGroups": [ { "type": "object", "name": "ref_name", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "include", "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
" } ] } ] }, { "type": "array of objects", "name": "deleted", "description": "", "childParamsGroups": [ { "type": "object", "name": "ref_name", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "include", "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
" } ] } ] }, { "type": "array of objects", "name": "updated", "description": "", "childParamsGroups": [ { "type": "object", "name": "condition", "description": "Parameters for a repository ruleset ref name condition
", "childParamsGroups": [ { "type": "object", "name": "ref_name", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "include", "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
" } ] } ] }, { "type": "object", "name": "changes", "description": "", "childParamsGroups": [ { "type": "object", "name": "condition_type", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "" } ] }, { "type": "object", "name": "target", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "" } ] }, { "type": "object", "name": "include", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "from", "description": "" } ] }, { "type": "object", "name": "exclude", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "from", "description": "" } ] } ] } ] } ] }, { "type": "object", "name": "rules", "description": "", "childParamsGroups": [ { "type": "array of objects", "name": "added", "description": "", "childParamsGroups": [ { "type": "object", "name": "creation", "description": "Only allow users with bypass permission to create matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "creation" ] } ] }, { "type": "object", "name": "update", "description": "Only allow users with bypass permission to update matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "update" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "update_allows_fetch_and_merge", "description": "Branch can pull changes from its upstream repository
", "isRequired": true } ] } ] }, { "type": "object", "name": "deletion", "description": "Only allow users with bypass permissions to delete matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "deletion" ] } ] }, { "type": "object", "name": "required_linear_history", "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_linear_history" ] } ] }, { "type": "object", "name": "merge_queue", "description": "Merges must be performed via a merge queue.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "merge_queue" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "check_response_timeout_minutes", "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", "isRequired": true }, { "type": "string", "name": "grouping_strategy", "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", "isRequired": true, "enum": [ "ALLGREEN", "HEADGREEN" ] }, { "type": "integer", "name": "max_entries_to_build", "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", "isRequired": true }, { "type": "integer", "name": "max_entries_to_merge", "description": "The maximum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "string", "name": "merge_method", "description": "Method to use when merging changes from queued pull requests.
", "isRequired": true, "enum": [ "MERGE", "SQUASH", "REBASE" ] }, { "type": "integer", "name": "min_entries_to_merge", "description": "The minimum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "integer", "name": "min_entries_to_merge_wait_minutes", "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_deployments", "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_deployments" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "required_deployment_environments", "description": "The environments that must be successfully deployed to before branches can be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_signatures", "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_signatures" ] } ] }, { "type": "object", "name": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "pull_request" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "allowed_merge_methods", "description": "Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.\nSupported values are: merge, squash, rebase
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" }, { "type": "boolean", "name": "dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.
", "isRequired": true }, { "type": "boolean", "name": "require_code_owner_review", "description": "Require an approving review in pull requests that modify files that have a designated code owner.
", "isRequired": true }, { "type": "boolean", "name": "require_last_push_approval", "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
", "isRequired": true }, { "type": "integer", "name": "required_approving_review_count", "description": "The number of approving reviews that are required before a pull request can be merged.
", "isRequired": true }, { "type": "boolean", "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true }, { "type": "array of objects", "name": "required_reviewers", "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", "childParamsGroups": [ { "type": "array of strings", "name": "file_patterns", "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", "isRequired": true }, { "type": "integer", "name": "minimum_approvals", "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", "isRequired": true }, { "type": "object", "name": "reviewer", "description": "A required reviewing team
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "ID of the reviewer which must review changes to matching files.
", "isRequired": true }, { "type": "string", "name": "type", "description": "The type of the reviewer
", "isRequired": true, "enum": [ "Team" ] } ] } ] } ] } ] }, { "type": "object", "name": "required_status_checks", "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_status_checks" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "required_status_checks", "description": "Status checks that are required.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "context", "description": "The status check context name that must be present on the commit.
", "isRequired": true }, { "type": "integer", "name": "integration_id", "description": "The optional integration ID that this status check must originate from.
" } ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
", "isRequired": true } ] } ] }, { "type": "object", "name": "non_fast_forward", "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "non_fast_forward" ] } ] }, { "type": "object", "name": "commit_message_pattern", "description": "Parameters to be used for the commit_message_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_message_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "commit_author_email_pattern", "description": "Parameters to be used for the commit_author_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_author_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "committer_email_pattern", "description": "Parameters to be used for the committer_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "committer_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "branch_name_pattern", "description": "Parameters to be used for the branch_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "branch_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "tag_name_pattern", "description": "Parameters to be used for the tag_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "tag_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_path_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_paths", "description": "The file paths that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_path_length", "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_path_length" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_path_length", "description": "The maximum amount of characters allowed in file paths.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_extension_restriction", "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_extension_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_extensions", "description": "The file extensions that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_size", "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_size" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_size", "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
", "isRequired": true } ] } ] }, { "type": "object", "name": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "workflows" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "workflows", "description": "Workflows that must pass for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "path", "description": "The path to the workflow file
", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref (branch or tag) of the workflow file to use
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository where the workflow is defined
", "isRequired": true }, { "type": "string", "name": "sha", "description": "The commit SHA of the workflow file to use
" } ] } ] } ] }, { "type": "object", "name": "code_scanning", "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "code_scanning" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of objects", "name": "code_scanning_tools", "description": "Tools that must provide code scanning results for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "alerts_threshold", "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "errors", "errors_and_warnings", "all" ] }, { "type": "string", "name": "security_alerts_threshold", "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "critical", "high_or_higher", "medium_or_higher", "all" ] }, { "type": "string", "name": "tool", "description": "The name of a code scanning tool
", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "copilot_code_review", "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "copilot_code_review" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "review_draft_pull_requests", "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" }, { "type": "boolean", "name": "review_on_push", "description": "Copilot automatically reviews each new push to the pull request.
" } ] } ] } ], "oneOfObject": true }, { "type": "array of objects", "name": "deleted", "description": "", "childParamsGroups": [ { "type": "object", "name": "creation", "description": "Only allow users with bypass permission to create matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "creation" ] } ] }, { "type": "object", "name": "update", "description": "Only allow users with bypass permission to update matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "update" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "update_allows_fetch_and_merge", "description": "Branch can pull changes from its upstream repository
", "isRequired": true } ] } ] }, { "type": "object", "name": "deletion", "description": "Only allow users with bypass permissions to delete matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "deletion" ] } ] }, { "type": "object", "name": "required_linear_history", "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_linear_history" ] } ] }, { "type": "object", "name": "merge_queue", "description": "Merges must be performed via a merge queue.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "merge_queue" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "check_response_timeout_minutes", "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", "isRequired": true }, { "type": "string", "name": "grouping_strategy", "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", "isRequired": true, "enum": [ "ALLGREEN", "HEADGREEN" ] }, { "type": "integer", "name": "max_entries_to_build", "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", "isRequired": true }, { "type": "integer", "name": "max_entries_to_merge", "description": "The maximum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "string", "name": "merge_method", "description": "Method to use when merging changes from queued pull requests.
", "isRequired": true, "enum": [ "MERGE", "SQUASH", "REBASE" ] }, { "type": "integer", "name": "min_entries_to_merge", "description": "The minimum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "integer", "name": "min_entries_to_merge_wait_minutes", "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_deployments", "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_deployments" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "required_deployment_environments", "description": "The environments that must be successfully deployed to before branches can be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_signatures", "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_signatures" ] } ] }, { "type": "object", "name": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "pull_request" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "allowed_merge_methods", "description": "Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.\nSupported values are: merge, squash, rebase
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" }, { "type": "boolean", "name": "dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.
", "isRequired": true }, { "type": "boolean", "name": "require_code_owner_review", "description": "Require an approving review in pull requests that modify files that have a designated code owner.
", "isRequired": true }, { "type": "boolean", "name": "require_last_push_approval", "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
", "isRequired": true }, { "type": "integer", "name": "required_approving_review_count", "description": "The number of approving reviews that are required before a pull request can be merged.
", "isRequired": true }, { "type": "boolean", "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true }, { "type": "array of objects", "name": "required_reviewers", "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", "childParamsGroups": [ { "type": "array of strings", "name": "file_patterns", "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", "isRequired": true }, { "type": "integer", "name": "minimum_approvals", "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", "isRequired": true }, { "type": "object", "name": "reviewer", "description": "A required reviewing team
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "ID of the reviewer which must review changes to matching files.
", "isRequired": true }, { "type": "string", "name": "type", "description": "The type of the reviewer
", "isRequired": true, "enum": [ "Team" ] } ] } ] } ] } ] }, { "type": "object", "name": "required_status_checks", "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_status_checks" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "required_status_checks", "description": "Status checks that are required.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "context", "description": "The status check context name that must be present on the commit.
", "isRequired": true }, { "type": "integer", "name": "integration_id", "description": "The optional integration ID that this status check must originate from.
" } ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
", "isRequired": true } ] } ] }, { "type": "object", "name": "non_fast_forward", "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "non_fast_forward" ] } ] }, { "type": "object", "name": "commit_message_pattern", "description": "Parameters to be used for the commit_message_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_message_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "commit_author_email_pattern", "description": "Parameters to be used for the commit_author_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_author_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "committer_email_pattern", "description": "Parameters to be used for the committer_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "committer_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "branch_name_pattern", "description": "Parameters to be used for the branch_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "branch_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "tag_name_pattern", "description": "Parameters to be used for the tag_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "tag_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_path_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_paths", "description": "The file paths that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_path_length", "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_path_length" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_path_length", "description": "The maximum amount of characters allowed in file paths.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_extension_restriction", "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_extension_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_extensions", "description": "The file extensions that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_size", "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_size" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_size", "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
", "isRequired": true } ] } ] }, { "type": "object", "name": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "workflows" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "workflows", "description": "Workflows that must pass for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "path", "description": "The path to the workflow file
", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref (branch or tag) of the workflow file to use
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository where the workflow is defined
", "isRequired": true }, { "type": "string", "name": "sha", "description": "The commit SHA of the workflow file to use
" } ] } ] } ] }, { "type": "object", "name": "code_scanning", "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "code_scanning" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of objects", "name": "code_scanning_tools", "description": "Tools that must provide code scanning results for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "alerts_threshold", "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "errors", "errors_and_warnings", "all" ] }, { "type": "string", "name": "security_alerts_threshold", "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "critical", "high_or_higher", "medium_or_higher", "all" ] }, { "type": "string", "name": "tool", "description": "The name of a code scanning tool
", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "copilot_code_review", "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "copilot_code_review" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "review_draft_pull_requests", "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" }, { "type": "boolean", "name": "review_on_push", "description": "Copilot automatically reviews each new push to the pull request.
" } ] } ] } ], "oneOfObject": true }, { "type": "array of objects", "name": "updated", "description": "", "childParamsGroups": [ { "type": "object", "name": "rule", "description": "A repository rule.
", "childParamsGroups": [ { "type": "object", "name": "creation", "description": "Only allow users with bypass permission to create matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "creation" ] } ] }, { "type": "object", "name": "update", "description": "Only allow users with bypass permission to update matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "update" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "update_allows_fetch_and_merge", "description": "Branch can pull changes from its upstream repository
", "isRequired": true } ] } ] }, { "type": "object", "name": "deletion", "description": "Only allow users with bypass permissions to delete matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "deletion" ] } ] }, { "type": "object", "name": "required_linear_history", "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_linear_history" ] } ] }, { "type": "object", "name": "merge_queue", "description": "Merges must be performed via a merge queue.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "merge_queue" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "check_response_timeout_minutes", "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", "isRequired": true }, { "type": "string", "name": "grouping_strategy", "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", "isRequired": true, "enum": [ "ALLGREEN", "HEADGREEN" ] }, { "type": "integer", "name": "max_entries_to_build", "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", "isRequired": true }, { "type": "integer", "name": "max_entries_to_merge", "description": "The maximum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "string", "name": "merge_method", "description": "Method to use when merging changes from queued pull requests.
", "isRequired": true, "enum": [ "MERGE", "SQUASH", "REBASE" ] }, { "type": "integer", "name": "min_entries_to_merge", "description": "The minimum number of PRs that will be merged together in a group.
", "isRequired": true }, { "type": "integer", "name": "min_entries_to_merge_wait_minutes", "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_deployments", "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_deployments" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "required_deployment_environments", "description": "The environments that must be successfully deployed to before branches can be merged.
", "isRequired": true } ] } ] }, { "type": "object", "name": "required_signatures", "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_signatures" ] } ] }, { "type": "object", "name": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "pull_request" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "allowed_merge_methods", "description": "Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.\nSupported values are: merge, squash, rebase
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" }, { "type": "boolean", "name": "dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.
", "isRequired": true }, { "type": "boolean", "name": "require_code_owner_review", "description": "Require an approving review in pull requests that modify files that have a designated code owner.
", "isRequired": true }, { "type": "boolean", "name": "require_last_push_approval", "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
", "isRequired": true }, { "type": "integer", "name": "required_approving_review_count", "description": "The number of approving reviews that are required before a pull request can be merged.
", "isRequired": true }, { "type": "boolean", "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true }, { "type": "array of objects", "name": "required_reviewers", "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", "childParamsGroups": [ { "type": "array of strings", "name": "file_patterns", "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", "isRequired": true }, { "type": "integer", "name": "minimum_approvals", "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", "isRequired": true }, { "type": "object", "name": "reviewer", "description": "A required reviewing team
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "ID of the reviewer which must review changes to matching files.
", "isRequired": true }, { "type": "string", "name": "type", "description": "The type of the reviewer
", "isRequired": true, "enum": [ "Team" ] } ] } ] } ] } ] }, { "type": "object", "name": "required_status_checks", "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "required_status_checks" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "required_status_checks", "description": "Status checks that are required.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "context", "description": "The status check context name that must be present on the commit.
", "isRequired": true }, { "type": "integer", "name": "integration_id", "description": "The optional integration ID that this status check must originate from.
" } ] }, { "type": "boolean", "name": "strict_required_status_checks_policy", "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
", "isRequired": true } ] } ] }, { "type": "object", "name": "non_fast_forward", "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "non_fast_forward" ] } ] }, { "type": "object", "name": "commit_message_pattern", "description": "Parameters to be used for the commit_message_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_message_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "commit_author_email_pattern", "description": "Parameters to be used for the commit_author_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "commit_author_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "committer_email_pattern", "description": "Parameters to be used for the committer_email_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "committer_email_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "branch_name_pattern", "description": "Parameters to be used for the branch_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "branch_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "tag_name_pattern", "description": "Parameters to be used for the tag_name_pattern rule
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "tag_name_pattern" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "string", "name": "name", "description": "How this rule will appear to users.
" }, { "type": "boolean", "name": "negate", "description": "If true, the rule will fail if the pattern matches.
" }, { "type": "string", "name": "operator", "description": "The operator to use for matching.
", "isRequired": true, "enum": [ "starts_with", "ends_with", "contains", "regex" ] }, { "type": "string", "name": "pattern", "description": "The pattern to match with.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_path_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_paths", "description": "The file paths that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_path_length", "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_path_length" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_path_length", "description": "The maximum amount of characters allowed in file paths.
", "isRequired": true } ] } ] }, { "type": "object", "name": "file_extension_restriction", "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "file_extension_restriction" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of strings", "name": "restricted_file_extensions", "description": "The file extensions that are restricted from being pushed to the commit graph.
", "isRequired": true } ] } ] }, { "type": "object", "name": "max_file_size", "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "max_file_size" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "integer", "name": "max_file_size", "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
", "isRequired": true } ] } ] }, { "type": "object", "name": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "workflows" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "do_not_enforce_on_create", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it.
" }, { "type": "array of objects", "name": "workflows", "description": "Workflows that must pass for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "path", "description": "The path to the workflow file
", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref (branch or tag) of the workflow file to use
" }, { "type": "integer", "name": "repository_id", "description": "The ID of the repository where the workflow is defined
", "isRequired": true }, { "type": "string", "name": "sha", "description": "The commit SHA of the workflow file to use
" } ] } ] } ] }, { "type": "object", "name": "code_scanning", "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "code_scanning" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "array of objects", "name": "code_scanning_tools", "description": "Tools that must provide code scanning results for this rule to pass.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "alerts_threshold", "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "errors", "errors_and_warnings", "all" ] }, { "type": "string", "name": "security_alerts_threshold", "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", "isRequired": true, "enum": [ "none", "critical", "high_or_higher", "medium_or_higher", "all" ] }, { "type": "string", "name": "tool", "description": "The name of a code scanning tool
", "isRequired": true } ] } ] } ] }, { "type": "object", "name": "copilot_code_review", "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", "isRequired": [ "type" ], "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true, "enum": [ "copilot_code_review" ] }, { "type": "object", "name": "parameters", "description": "", "childParamsGroups": [ { "type": "boolean", "name": "review_draft_pull_requests", "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" }, { "type": "boolean", "name": "review_on_push", "description": "Copilot automatically reviews each new push to the pull request.
" } ] } ] } ], "oneOfObject": true }, { "type": "object", "name": "changes", "description": "", "childParamsGroups": [ { "type": "object", "name": "configuration", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "" } ] }, { "type": "object", "name": "rule_type", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "" } ] }, { "type": "object", "name": "pattern", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "" } ] } ] } ] } ] } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "edited", "category": "repository_ruleset" } }, "repository_vulnerability_alert": { "create": { "descriptionHtml": "A repository vulnerability alert was created.
", "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
The security alert of the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "affected_package_name", "description": "", "isRequired": true }, { "type": "string", "name": "affected_range", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "dismiss_reason", "description": "" }, { "type": "string", "name": "dismissed_at", "description": "" }, { "type": "object or null", "name": "dismisser", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "external_identifier", "description": "", "isRequired": true }, { "type": "string or null", "name": "external_reference", "description": "", "isRequired": true }, { "type": "string", "name": "fix_reason", "description": "" }, { "type": "string", "name": "fixed_at", "description": "" }, { "type": "string", "name": "fixed_in", "description": "" }, { "type": "string", "name": "ghsa_id", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open" ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization" ], "action": "create", "category": "repository_vulnerability_alert" }, "dismiss": { "descriptionHtml": "A repository vulnerability alert was dismissed.
", "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
The security alert of the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "affected_package_name", "description": "", "isRequired": true }, { "type": "string", "name": "affected_range", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "dismiss_comment", "description": "" }, { "type": "string", "name": "dismiss_reason", "description": "", "isRequired": true }, { "type": "string", "name": "dismissed_at", "description": "", "isRequired": true }, { "type": "object or null", "name": "dismisser", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "external_identifier", "description": "", "isRequired": true }, { "type": "string or null", "name": "external_reference", "description": "", "isRequired": true }, { "type": "string", "name": "fix_reason", "description": "" }, { "type": "string", "name": "fixed_at", "description": "" }, { "type": "string", "name": "fixed_in", "description": "" }, { "type": "string", "name": "ghsa_id", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "dismissed" ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization" ], "action": "dismiss", "category": "repository_vulnerability_alert" }, "reopen": { "descriptionHtml": "A previously dismissed or resolved repository vulnerability alert was reopened.
", "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
The security alert of the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "affected_package_name", "description": "", "isRequired": true }, { "type": "string", "name": "affected_range", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "dismiss_reason", "description": "" }, { "type": "string", "name": "dismissed_at", "description": "" }, { "type": "object or null", "name": "dismisser", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "external_identifier", "description": "", "isRequired": true }, { "type": "string or null", "name": "external_reference", "description": "", "isRequired": true }, { "type": "string", "name": "fix_reason", "description": "" }, { "type": "string", "name": "fixed_at", "description": "" }, { "type": "string", "name": "fixed_in", "description": "" }, { "type": "string", "name": "ghsa_id", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "open" ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization" ], "action": "reopen", "category": "repository_vulnerability_alert" }, "resolve": { "descriptionHtml": "A repository vulnerability alert was marked as resolved.
", "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
The security alert of the vulnerable dependency.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "affected_package_name", "description": "", "isRequired": true }, { "type": "string", "name": "affected_range", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "dismiss_reason", "description": "" }, { "type": "string", "name": "dismissed_at", "description": "" }, { "type": "object or null", "name": "dismisser", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "external_identifier", "description": "", "isRequired": true }, { "type": "string or null", "name": "external_reference", "description": "", "isRequired": true }, { "type": "string", "name": "fix_reason", "description": "" }, { "type": "string", "name": "fixed_at", "description": "" }, { "type": "string", "name": "fixed_in", "description": "" }, { "type": "string", "name": "ghsa_id", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true, "enum": [ "fixed", "open" ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization" ], "action": "resolve", "category": "repository_vulnerability_alert" } }, "secret_scanning_alert": { "created": { "descriptionHtml": "A secret scanning alert was created.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
" }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
" }, { "type": "string", "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, { "type": "string or null", "name": "resolution", "description": "The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", "pattern_deleted", "pattern_edited", null ] }, { "type": "string or null", "name": "resolved_at", "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "resolution_comment", "description": "An optional comment to resolve an alert.
" }, { "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, { "type": "string", "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", "enum": [ "active", "inactive", "unknown" ] }, { "type": "boolean or null", "name": "push_protection_bypassed", "description": "Whether push protection was bypassed for the detected secret.
" }, { "type": "object", "name": "push_protection_bypassed_by", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypassed_at", "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypass_request_reviewer_comment", "description": "An optional comment when reviewing a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_comment", "description": "An optional comment when requesting a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_html_url", "description": "The URL to a push protection bypass request.
" }, { "type": "boolean or null", "name": "multi_repo", "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "secret_scanning_alert" }, "reopened": { "descriptionHtml": "A previously closed secret scanning alert was reopened.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "reopened" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
" }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
" }, { "type": "string", "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, { "type": "string or null", "name": "resolution", "description": "The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", "pattern_deleted", "pattern_edited", null ] }, { "type": "string or null", "name": "resolved_at", "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "resolution_comment", "description": "An optional comment to resolve an alert.
" }, { "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, { "type": "string", "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", "enum": [ "active", "inactive", "unknown" ] }, { "type": "boolean or null", "name": "push_protection_bypassed", "description": "Whether push protection was bypassed for the detected secret.
" }, { "type": "object", "name": "push_protection_bypassed_by", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypassed_at", "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypass_request_reviewer_comment", "description": "An optional comment when reviewing a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_comment", "description": "An optional comment when requesting a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_html_url", "description": "The URL to a push protection bypass request.
" }, { "type": "boolean or null", "name": "multi_repo", "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "reopened", "category": "secret_scanning_alert" }, "resolved": { "descriptionHtml": "A secret scanning alert was closed.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "resolved" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
" }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
" }, { "type": "string", "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, { "type": "string or null", "name": "resolution", "description": "The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", "pattern_deleted", "pattern_edited", null ] }, { "type": "string or null", "name": "resolved_at", "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "resolution_comment", "description": "An optional comment to resolve an alert.
" }, { "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, { "type": "string", "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", "enum": [ "active", "inactive", "unknown" ] }, { "type": "boolean or null", "name": "push_protection_bypassed", "description": "Whether push protection was bypassed for the detected secret.
" }, { "type": "object", "name": "push_protection_bypassed_by", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypassed_at", "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypass_request_reviewer_comment", "description": "An optional comment when reviewing a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_comment", "description": "An optional comment when requesting a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_html_url", "description": "The URL to a push protection bypass request.
" }, { "type": "boolean or null", "name": "multi_repo", "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "resolved", "category": "secret_scanning_alert" }, "validated": { "descriptionHtml": "A secret scanning alert was validated.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "validated" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
" }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
" }, { "type": "string", "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, { "type": "string or null", "name": "resolution", "description": "The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", "pattern_deleted", "pattern_edited", null ] }, { "type": "string or null", "name": "resolved_at", "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "resolution_comment", "description": "An optional comment to resolve an alert.
" }, { "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, { "type": "string", "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", "enum": [ "active", "inactive", "unknown" ] }, { "type": "boolean or null", "name": "push_protection_bypassed", "description": "Whether push protection was bypassed for the detected secret.
" }, { "type": "object", "name": "push_protection_bypassed_by", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypassed_at", "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypass_request_reviewer_comment", "description": "An optional comment when reviewing a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_comment", "description": "An optional comment when requesting a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_html_url", "description": "The URL to a push protection bypass request.
" }, { "type": "boolean or null", "name": "multi_repo", "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "validated", "category": "secret_scanning_alert" } }, "secret_scanning_alert_location": { "created": { "descriptionHtml": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.
", "summaryHtml": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.
\nFor more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alerts, use the secret_scanning_alert event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "alert", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "number", "description": "The security alert number.
" }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" }, { "type": "string", "name": "html_url", "description": "The GitHub URL of the alert resource.
" }, { "type": "string", "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, { "type": "string or null", "name": "resolution", "description": "The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", "pattern_deleted", "pattern_edited", null ] }, { "type": "string or null", "name": "resolved_at", "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "resolution_comment", "description": "An optional comment to resolve an alert.
" }, { "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, { "type": "string", "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", "enum": [ "active", "inactive", "unknown" ] }, { "type": "boolean or null", "name": "push_protection_bypassed", "description": "Whether push protection was bypassed for the detected secret.
" }, { "type": "object", "name": "push_protection_bypassed_by", "description": "A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypassed_at", "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string or null", "name": "push_protection_bypass_request_reviewer_comment", "description": "An optional comment when reviewing a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_comment", "description": "An optional comment when requesting a push protection bypass.
" }, { "type": "string or null", "name": "push_protection_bypass_request_html_url", "description": "The URL to a push protection bypass request.
" }, { "type": "boolean or null", "name": "multi_repo", "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" } ] }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.
", "enum": [ "commit", "wiki_commit", "issue_title", "issue_body", "issue_comment", "discussion_title", "discussion_body", "discussion_comment", "pull_request_title", "pull_request_body", "pull_request_comment", "pull_request_review", "pull_request_review_comment" ] }, { "type": "object", "name": "details", "description": "", "childParamsGroups": [ { "type": "object", "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
", "isRequired": [ "path", "start_line", "end_line", "start_column", "end_column", "blob_sha", "blob_url", "commit_sha", "commit_url" ], "childParamsGroups": [ { "type": "string", "name": "path", "description": "The file path in the repository
", "isRequired": true }, { "type": "number", "name": "start_line", "description": "Line number at which the secret starts in the file
", "isRequired": true }, { "type": "number", "name": "end_line", "description": "Line number at which the secret ends in the file
", "isRequired": true }, { "type": "number", "name": "start_column", "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
", "isRequired": true }, { "type": "number", "name": "end_column", "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
", "isRequired": true }, { "type": "string", "name": "blob_sha", "description": "SHA-1 hash ID of the associated blob
", "isRequired": true }, { "type": "string", "name": "blob_url", "description": "The API URL to get the associated blob resource
", "isRequired": true }, { "type": "string", "name": "commit_sha", "description": "SHA-1 hash ID of the associated commit
", "isRequired": true }, { "type": "string", "name": "commit_url", "description": "The API URL to get the associated commit resource
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.
", "isRequired": [ "path", "start_line", "end_line", "start_column", "end_column", "blob_sha", "page_url", "commit_sha", "commit_url" ], "childParamsGroups": [ { "type": "string", "name": "path", "description": "The file path of the wiki page
", "isRequired": true }, { "type": "number", "name": "start_line", "description": "Line number at which the secret starts in the file
", "isRequired": true }, { "type": "number", "name": "end_line", "description": "Line number at which the secret ends in the file
", "isRequired": true }, { "type": "number", "name": "start_column", "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.
", "isRequired": true }, { "type": "number", "name": "end_column", "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.
", "isRequired": true }, { "type": "string", "name": "blob_sha", "description": "SHA-1 hash ID of the associated blob
", "isRequired": true }, { "type": "string", "name": "page_url", "description": "The GitHub URL to get the associated wiki page
", "isRequired": true }, { "type": "string", "name": "commit_sha", "description": "SHA-1 hash ID of the associated commit
", "isRequired": true }, { "type": "string", "name": "commit_url", "description": "The GitHub URL to get the associated wiki commit
", "isRequired": true } ] }, { "type": "object", "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
", "isRequired": [ "issue_title_url" ], "childParamsGroups": [ { "type": "string", "name": "issue_title_url", "description": "The API URL to get the issue where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
", "isRequired": [ "issue_body_url" ], "childParamsGroups": [ { "type": "string", "name": "issue_body_url", "description": "The API URL to get the issue where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
", "isRequired": [ "issue_comment_url" ], "childParamsGroups": [ { "type": "string", "name": "issue_comment_url", "description": "The API URL to get the issue comment where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
", "isRequired": [ "discussion_title_url" ], "childParamsGroups": [ { "type": "string", "name": "discussion_title_url", "description": "The URL to the discussion where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
", "isRequired": [ "discussion_body_url" ], "childParamsGroups": [ { "type": "string", "name": "discussion_body_url", "description": "The URL to the discussion where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
", "isRequired": [ "discussion_comment_url" ], "childParamsGroups": [ { "type": "string", "name": "discussion_comment_url", "description": "The API URL to get the discussion comment where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
", "isRequired": [ "pull_request_title_url" ], "childParamsGroups": [ { "type": "string", "name": "pull_request_title_url", "description": "The API URL to get the pull request where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
", "isRequired": [ "pull_request_body_url" ], "childParamsGroups": [ { "type": "string", "name": "pull_request_body_url", "description": "The API URL to get the pull request where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
", "isRequired": [ "pull_request_comment_url" ], "childParamsGroups": [ { "type": "string", "name": "pull_request_comment_url", "description": "The API URL to get the pull request comment where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
", "isRequired": [ "pull_request_review_url" ], "childParamsGroups": [ { "type": "string", "name": "pull_request_review_url", "description": "The API URL to get the pull request review where the secret was detected.
", "isRequired": true } ] }, { "type": "object", "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.
", "isRequired": [ "pull_request_review_comment_url" ], "childParamsGroups": [ { "type": "string", "name": "pull_request_review_comment_url", "description": "The API URL to get the pull request review comment where the secret was detected.
", "isRequired": true } ] } ], "oneOfObject": true } ] }, { "type": "object", "name": "organization", "in": "body", "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "created", "category": "secret_scanning_alert_location" } }, "secret_scanning_scan": { "completed": { "descriptionHtml": "A secret scanning scan was completed.
", "summaryHtml": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"About secret scanning.\"
\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"About custom patterns.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "completed" ], "childParamsGroups": [] }, { "type": "string", "name": "type", "in": "body", "description": "What type of scan was completed
", "isRequired": true, "enum": [ "backfill", "custom-pattern-backfill", "pattern-version-backfill" ] }, { "type": "string", "name": "source", "in": "body", "description": "What type of content was scanned
", "isRequired": true, "enum": [ "git", "issues", "pull-requests", "discussions", "wiki" ] }, { "type": "string", "name": "started_at", "in": "body", "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates
" }, { "type": "string or null", "name": "custom_pattern_name", "in": "body", "description": "If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated
" }, { "type": "string or null", "name": "custom_pattern_scope", "in": "body", "description": "If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated
", "enum": [ "repository", "organization", "enterprise", null ] }, { "type": "object", "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "completed", "category": "secret_scanning_scan" } }, "security_advisory": { "published": { "descriptionHtml": "A security advisory was published to the GitHub community.
", "summaryHtml": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "published" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The details of the security advisory, including summary, description, and severity.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "cvss", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "array of objects", "name": "cwes", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "ghsa_id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "identifiers", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "string", "name": "value", "description": "", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "", "isRequired": true }, { "type": "array of objects", "name": "references", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "summary", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "first_patched_version", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "", "isRequired": true } ] }, { "type": "object", "name": "package", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "vulnerable_version_range", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "withdrawn_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "app" ], "action": "published", "category": "security_advisory" }, "updated": { "descriptionHtml": "The metadata or description of a security advisory was changed.
", "summaryHtml": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "updated" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The details of the security advisory, including summary, description, and severity.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "cvss", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "array of objects", "name": "cwes", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "ghsa_id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "identifiers", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "string", "name": "value", "description": "", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "", "isRequired": true }, { "type": "array of objects", "name": "references", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "summary", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "first_patched_version", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "", "isRequired": true } ] }, { "type": "object", "name": "package", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "vulnerable_version_range", "description": "", "isRequired": true } ] }, { "type": "string or null", "name": "withdrawn_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "app" ], "action": "updated", "category": "security_advisory" }, "withdrawn": { "descriptionHtml": "A previously published security advisory was withdrawn.
", "summaryHtml": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "withdrawn" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
The details of the security advisory, including summary, description, and severity.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "cvss", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "number", "name": "score", "description": "", "isRequired": true }, { "type": "string or null", "name": "vector_string", "description": "", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_severities", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "cvss_v3", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 3 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 3 score.
", "isRequired": true } ] }, { "type": "object or null", "name": "cvss_v4", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "vector_string", "description": "The CVSS 4 vector string.
", "isRequired": true }, { "type": "number or null", "name": "score", "description": "The CVSS 4 score.
", "isRequired": true } ] } ] }, { "type": "array of objects", "name": "cwes", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "cwe_id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] }, { "type": "string", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "ghsa_id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "identifiers", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "string", "name": "value", "description": "", "isRequired": true } ] }, { "type": "string", "name": "published_at", "description": "", "isRequired": true }, { "type": "array of objects", "name": "references", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "summary", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "array of objects", "name": "vulnerabilities", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "first_patched_version", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "identifier", "description": "", "isRequired": true } ] }, { "type": "object", "name": "package", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ecosystem", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true } ] }, { "type": "string", "name": "severity", "description": "", "isRequired": true }, { "type": "string", "name": "vulnerable_version_range", "description": "", "isRequired": true } ] }, { "type": "string", "name": "withdrawn_at", "description": "", "isRequired": true } ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "app" ], "action": "withdrawn", "category": "security_advisory" } }, "security_and_analysis": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"GitHub security features.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "from", "description": "", "childParamsGroups": [ { "type": "object or null", "name": "security_and_analysis", "description": "", "childParamsGroups": [ { "type": "object", "name": "advanced_security", "description": "Enable or disable GitHub Advanced Security for the repository.
\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "code_security", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "dependabot_security_updates", "description": "Enable or disable Dependabot security updates for the repository.
", "childParamsGroups": [ { "type": "string", "name": "status", "description": "The enablement status of Dependabot security updates for the repository.
", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_push_protection", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] }, { "type": "object", "name": "secret_scanning_non_provider_patterns", "description": "", "childParamsGroups": [ { "type": "string", "name": "status", "description": "", "enum": [ "enabled", "disabled" ] } ] } ] } ] } ] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
Full Repository
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "security_and_analysis" } }, "sponsorship": { "cancelled": { "descriptionHtml": "A sponsorship was cancelled and the last billing cycle has ended.
\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
", "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "cancelled" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "sponsorship", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object", "name": "maintainer", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "privacy_level", "description": "", "isRequired": true }, { "type": "object or null", "name": "sponsor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "sponsorable", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "tier", "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.
", "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "sponsorship", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object", "name": "maintainer", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "privacy_level", "description": "", "isRequired": true }, { "type": "object or null", "name": "sponsor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "sponsorable", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "tier", "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.
", "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "privacy_level", "description": "", "childParamsGroups": [ { "type": "string", "name": "from", "description": "The edited event types include the details about the change when someone edits a sponsorship to change the privacy.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "sponsorship", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object", "name": "maintainer", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "privacy_level", "description": "", "isRequired": true }, { "type": "object or null", "name": "sponsor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "sponsorable", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "tier", "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.
\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
", "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "pending_cancellation" ], "childParamsGroups": [] }, { "type": "string", "name": "effective_date", "in": "body", "description": "The pending_cancellation and pending_tier_change event types will include the date the cancellation or tier change will take effect.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "sponsorship", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object", "name": "maintainer", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "privacy_level", "description": "", "isRequired": true }, { "type": "object or null", "name": "sponsor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "sponsorable", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "tier", "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.
", "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "pending_tier_change" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "tier", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "from", "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
The pending_cancellation and pending_tier_change event types will include the date the cancellation or tier change will take effect.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "sponsorship", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object", "name": "maintainer", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "privacy_level", "description": "", "isRequired": true }, { "type": "object or null", "name": "sponsor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "sponsorable", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "tier", "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.
", "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "tier_changed" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "tier", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "from", "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "sponsorship", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "object", "name": "maintainer", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "privacy_level", "description": "", "isRequired": true }, { "type": "object or null", "name": "sponsor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object or null", "name": "sponsorable", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "object", "name": "tier", "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
Someone starred a repository.
", "summaryHtml": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "string or null", "name": "starred_at", "in": "body", "description": "The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.
Someone unstarred the repository.
", "summaryHtml": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "null", "name": "starred_at", "in": "body", "description": "The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.
This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", "name": "avatar_url", "in": "body", "description": "" }, { "type": "array of objects", "name": "branches", "in": "body", "description": "An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "commit", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "sha", "description": "", "isRequired": true }, { "type": "string or null", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "boolean", "name": "protected", "description": "", "isRequired": true } ] }, { "type": "object", "name": "commit", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "object", "name": "commit", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "author", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "", "isRequired": true }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "integer", "name": "comment_count", "description": "", "isRequired": true }, { "type": "object", "name": "committer", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "", "isRequired": true }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "string", "name": "message", "description": "", "isRequired": true }, { "type": "object", "name": "tree", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "object", "name": "verification", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "payload", "description": "", "isRequired": true }, { "type": "string", "name": "reason", "description": "", "isRequired": true, "enum": [ "expired_key", "not_signing_key", "gpgverify_error", "gpgverify_unavailable", "unsigned", "unknown_signature_type", "no_user", "unverified_email", "bad_email", "unknown_key", "malformed_signature", "invalid", "valid", "bad_cert", "ocsp_pending" ] }, { "type": "string or null", "name": "signature", "description": "", "isRequired": true }, { "type": "boolean", "name": "verified", "description": "", "isRequired": true }, { "type": "string or null", "name": "verified_at", "description": "", "isRequired": true } ] } ] }, { "type": "object or null", "name": "committer", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "" }, { "type": "string", "name": "login", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "array of objects", "name": "parents", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "context", "in": "body", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "in": "body", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "in": "body", "description": "The optional human-readable description added to the status.
", "isRequired": true }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The unique identifier of the status.
", "isRequired": true }, { "type": "object", "name": "installation", "in": "body", "description": "The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "string", "name": "sha", "in": "body", "description": "The Commit SHA.
", "isRequired": true }, { "type": "string", "name": "state", "in": "body", "description": "The new state. Can be pending, success, failure, or error.
The optional link added to the status.
", "isRequired": true }, { "type": "string", "name": "updated_at", "in": "body", "description": "", "isRequired": true } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "status" } }, "team_add": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when a team is added to a repository.\nFor more information, see \"Managing teams and people with access to your repository.\"
\nFor activity relating to teams, see the teams event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "team", "in": "body", "description": "Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "isRequired": true, "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] } ], "availability": [ "repository", "organization", "app" ], "action": "default", "category": "team_add" } }, "team": { "added_to_repository": { "descriptionHtml": "A team was granted access to a repository.
", "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "added_to_repository" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A git repository
", "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] }, { "type": "object", "name": "team", "in": "body", "description": "Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "isRequired": true, "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] } ], "availability": [ "organization", "business", "app" ], "action": "added_to_repository", "category": "team" }, "created": { "descriptionHtml": "A team was created.
", "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A git repository
", "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "team", "in": "body", "description": "Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "isRequired": true, "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] } ], "availability": [ "organization", "business", "app" ], "action": "created", "category": "team" }, "deleted": { "descriptionHtml": "A team was deleted.
", "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A git repository
", "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "childParamsGroups": [] }, { "type": "object", "name": "team", "in": "body", "description": "Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "isRequired": true, "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] } ], "availability": [ "organization", "business", "app" ], "action": "deleted", "category": "team" }, "edited": { "descriptionHtml": "The name, description, or visibility of a team was changed.
", "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "edited" ], "childParamsGroups": [] }, { "type": "object", "name": "changes", "in": "body", "description": "The changes to the team if the action was edited.
The previous version of the description if the action was edited.
The previous version of the name if the action was edited.
The previous version of the team's privacy if the action was edited.
The previous version of the team's notification setting if the action was edited.
The previous version of the team member's admin permission on a repository, if the action was edited.
The previous version of the team member's pull permission on a repository, if the action was edited.
The previous version of the team member's push permission on a repository, if the action was edited.
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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A git repository
", "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "team", "in": "body", "description": "Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "isRequired": true, "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] } ], "availability": [ "organization", "business", "app" ], "action": "edited", "category": "team" }, "removed_from_repository": { "descriptionHtml": "A team's access to a repository was removed.
", "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "removed_from_repository" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
A git repository
", "childParamsGroups": [] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "team", "in": "body", "description": "Groups of organization members that gives permissions on specified repositories.
", "isRequired": true, "childParamsGroups": [ { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "description", "description": "Description of the team
" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "" }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "" }, { "type": "object or null", "name": "parent", "description": "", "childParamsGroups": [ { "type": "string or null", "name": "description", "description": "Description of the team
", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the team
", "isRequired": true }, { "type": "string", "name": "members_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "Name of the team
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
", "isRequired": true }, { "type": "string", "name": "privacy", "description": "", "isRequired": true, "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "isRequired": true, "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "", "isRequired": true }, { "type": "string", "name": "slug", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "URL for the team
", "isRequired": true }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "isRequired": true, "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] }, { "type": "string", "name": "permission", "description": "Permission that the team will have for its repositories
" }, { "type": "string", "name": "privacy", "description": "", "enum": [ "open", "closed", "secret" ] }, { "type": "string", "name": "notification_setting", "description": "Whether team members will receive notifications when their team is @mentioned
", "enum": [ "notifications_enabled", "notifications_disabled" ] }, { "type": "string", "name": "repositories_url", "description": "" }, { "type": "string", "name": "slug", "description": "" }, { "type": "string", "name": "url", "description": "URL for the team
" }, { "type": "string", "name": "type", "description": "The ownership type of the team
", "enum": [ "enterprise", "organization" ] }, { "type": "integer", "name": "organization_id", "description": "Unique identifier of the organization to which this team belongs
" }, { "type": "integer", "name": "enterprise_id", "description": "Unique identifier of the enterprise to which this team belongs
" } ] } ], "availability": [ "organization", "business", "app" ], "action": "removed_from_repository", "category": "team" } }, "user": { "created": { "descriptionHtml": "A user account was added to the enterprise.
", "summaryHtml": "This event occurs when there is activity relating to user accounts in an enterprise.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "created" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] }, { "type": "object or null", "name": "user", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ], "availability": [ "business" ], "action": "created", "category": "user" }, "deleted": { "descriptionHtml": "A user account was removed from the enterprise.
", "summaryHtml": "This event occurs when there is activity relating to user accounts in an enterprise.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "deleted" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] }, { "type": "object or null", "name": "user", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] } ], "availability": [ "business" ], "action": "deleted", "category": "user" } }, "watch": { "started": { "descriptionHtml": "Someone started watching the repository.
", "summaryHtml": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"Managing your subscriptions.\" For information about the APIs to manage watching, see \"Watching\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "started" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] } ], "availability": [ "repository", "organization", "app" ], "action": "started", "category": "watch" } }, "workflow_dispatch": { "default": { "descriptionHtml": "", "summaryHtml": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"Manually running a workflow.\"
\nFor activity relating to workflow runs, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "string", "name": "workflow", "in": "body", "description": "", "isRequired": true } ], "availability": [ "app" ], "action": "default", "category": "workflow_dispatch" } }, "workflow_job": { "completed": { "descriptionHtml": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.
", "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "completed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "workflow_job", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "check_run_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "success", "failure", null, "skipped", "cancelled", "action_required", "neutral", "timed_out" ] }, { "type": "string", "name": "created_at", "description": "The time that the job created.
", "isRequired": true }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of strings", "name": "labels", "description": "Custom labels for the job. Specified by the \"runs-on\" attribute in the workflow YAML.
The ID of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.
The name of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.
The ID of the runner that is running this job. This will be null as long as workflow_job[status] is queued.
The name of the runner that is running this job. This will be null as long as workflow_job[status] is queued.
The current status of the job. Can be queued, in_progress, waiting, or completed.
The name of the current branch.
", "isRequired": true }, { "type": "string or null", "name": "workflow_name", "description": "The name of the workflow.
", "isRequired": true }, { "type": "array of objects", "name": "steps", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "failure", "skipped", "success", "cancelled", null ] }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string or null", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "in_progress", "completed", "queued" ] } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "deployment", "in": "body", "description": "A request for a specific ref(branch,sha,tag) to be deployed
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref to deploy. This can be a branch, tag, or sha.
", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "object or string", "name": "payload", "description": "", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "completed", "category": "workflow_job" }, "in_progress": { "descriptionHtml": "A job in a workflow run started processing on a runner.
", "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "in_progress" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "workflow_job", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "check_run_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "success", "failure", null, "cancelled", "neutral" ] }, { "type": "string", "name": "created_at", "description": "The time that the job created.
", "isRequired": true }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of strings", "name": "labels", "description": "Custom labels for the job. Specified by the \"runs-on\" attribute in the workflow YAML.
The ID of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.
The name of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.
The ID of the runner that is running this job. This will be null as long as workflow_job[status] is queued.
The name of the runner that is running this job. This will be null as long as workflow_job[status] is queued.
The current status of the job. Can be queued, in_progress, or completed.
The name of the current branch.
", "isRequired": true }, { "type": "string or null", "name": "workflow_name", "description": "The name of the workflow.
", "isRequired": true }, { "type": "array of objects", "name": "steps", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "failure", "skipped", "success", null, "cancelled" ] }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string or null", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "in_progress", "completed", "queued", "pending" ] } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "deployment", "in": "body", "description": "A request for a specific ref(branch,sha,tag) to be deployed
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref to deploy. This can be a branch, tag, or sha.
", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "object or string", "name": "payload", "description": "", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "in_progress", "category": "workflow_job" }, "queued": { "descriptionHtml": "A job in a workflow run was created.
", "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "queued" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "workflow_job", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "check_run_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the job created.
", "isRequired": true }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of strings", "name": "labels", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "number", "name": "run_id", "description": "", "isRequired": true }, { "type": "string", "name": "run_url", "description": "", "isRequired": true }, { "type": "integer or null", "name": "runner_group_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "runner_group_name", "description": "", "isRequired": true }, { "type": "integer or null", "name": "runner_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "runner_name", "description": "", "isRequired": true }, { "type": "string", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "queued", "in_progress", "completed", "waiting" ] }, { "type": "string or null", "name": "head_branch", "description": "The name of the current branch.
", "isRequired": true }, { "type": "string or null", "name": "workflow_name", "description": "The name of the workflow.
", "isRequired": true }, { "type": "array of objects", "name": "steps", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "failure", "skipped", "success", "cancelled", null ] }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string or null", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "completed", "in_progress", "queued", "pending" ] } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "deployment", "in": "body", "description": "A request for a specific ref(branch,sha,tag) to be deployed
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref to deploy. This can be a branch, tag, or sha.
", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "object or string", "name": "payload", "description": "", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "queued", "category": "workflow_job" }, "waiting": { "descriptionHtml": "A job in a workflow run was created and is waiting for approvals.
", "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "waiting" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "workflow_job", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "check_run_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "The time that the job created.
", "isRequired": true }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "array of strings", "name": "labels", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "number", "name": "run_id", "description": "", "isRequired": true }, { "type": "string", "name": "run_url", "description": "", "isRequired": true }, { "type": "integer or null", "name": "runner_group_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "runner_group_name", "description": "", "isRequired": true }, { "type": "integer or null", "name": "runner_id", "description": "", "isRequired": true }, { "type": "string or null", "name": "runner_name", "description": "", "isRequired": true }, { "type": "string", "name": "started_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "head_branch", "description": "The name of the current branch.
", "isRequired": true }, { "type": "string or null", "name": "workflow_name", "description": "The name of the workflow.
", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "queued", "in_progress", "completed", "waiting" ] }, { "type": "array of objects", "name": "steps", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "failure", "skipped", "success", "cancelled", null ] }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "integer", "name": "number", "description": "", "isRequired": true }, { "type": "string or null", "name": "started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "completed", "in_progress", "queued", "pending", "waiting" ] } ] }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "deployment", "in": "body", "description": "A request for a specific ref(branch,sha,tag) to be deployed
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the deployment
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "sha", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "The ref to deploy. This can be a branch, tag, or sha.
", "isRequired": true }, { "type": "string", "name": "task", "description": "Parameter to specify a task to execute
", "isRequired": true }, { "type": "object or string", "name": "payload", "description": "", "isRequired": true }, { "type": "string", "name": "original_environment", "description": "" }, { "type": "string", "name": "environment", "description": "Name for the target deployment environment.
", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "object", "name": "creator", "description": "A GitHub user.
", "isRequired": true, "childParamsGroups": [ { "type": "string or null", "name": "name", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "avatar_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "gravatar_id", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "string", "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", "name": "following_url", "description": "", "isRequired": true }, { "type": "string", "name": "gists_url", "description": "", "isRequired": true }, { "type": "string", "name": "starred_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscriptions_url", "description": "", "isRequired": true }, { "type": "string", "name": "organizations_url", "description": "", "isRequired": true }, { "type": "string", "name": "repos_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "string", "name": "received_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "type", "description": "", "isRequired": true }, { "type": "boolean", "name": "site_admin", "description": "", "isRequired": true }, { "type": "string", "name": "starred_at", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "repository_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "transient_environment", "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" }, { "type": "boolean", "name": "production_environment", "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" }, { "type": "null", "name": "performed_via_github_app", "description": "" } ] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "waiting", "category": "workflow_job" } }, "workflow_run": { "completed": { "descriptionHtml": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
", "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "completed" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object or null", "name": "workflow", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "badge_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "workflow_run", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "artifacts_url", "description": "", "isRequired": true }, { "type": "string", "name": "cancel_url", "description": "", "isRequired": true }, { "type": "integer", "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "action_required", "cancelled", "failure", "neutral", "skipped", "stale", "success", "timed_out", "startup_failure", null ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "event", "description": "", "isRequired": true }, { "type": "string or null", "name": "head_branch", "description": "", "isRequired": true }, { "type": "object", "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "author", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "object", "name": "committer", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "string", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "message", "description": "", "isRequired": true }, { "type": "string", "name": "timestamp", "description": "", "isRequired": true }, { "type": "string", "name": "tree_id", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head_repository", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "jobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "logs_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string or null", "name": "previous_attempt_url", "description": "", "isRequired": true }, { "type": "array of object,nulls", "name": "pull_requests", "description": "", "isRequired": true }, { "type": "array of objects or null", "name": "referenced_workflows", "description": "", "childParamsGroups": [ { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "" }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "rerun_url", "description": "", "isRequired": true }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "integer", "name": "run_number", "description": "", "isRequired": true }, { "type": "string", "name": "run_started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "requested", "in_progress", "completed", "queued", "pending", "waiting" ] }, { "type": "object or null", "name": "triggering_actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", "name": "workflow_url", "description": "", "isRequired": true }, { "type": "string", "name": "display_title", "description": "The event-specific title associated with the run or the run-name if set, or the value of run-name if it is set in the workflow.
A workflow run started processing on a runner.
", "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "in_progress" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object or null", "name": "workflow", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "badge_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "workflow_run", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "artifacts_url", "description": "", "isRequired": true }, { "type": "string", "name": "cancel_url", "description": "", "isRequired": true }, { "type": "integer", "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "action_required", "cancelled", "failure", "neutral", "skipped", "stale", "success", "timed_out", null ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "event", "description": "", "isRequired": true }, { "type": "string or null", "name": "head_branch", "description": "", "isRequired": true }, { "type": "object", "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "author", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "object", "name": "committer", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "string", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "message", "description": "", "isRequired": true }, { "type": "string", "name": "timestamp", "description": "", "isRequired": true }, { "type": "string", "name": "tree_id", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head_repository", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "jobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "logs_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string or null", "name": "previous_attempt_url", "description": "", "isRequired": true }, { "type": "array of object,nulls", "name": "pull_requests", "description": "", "isRequired": true }, { "type": "array of objects or null", "name": "referenced_workflows", "description": "", "childParamsGroups": [ { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "" }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "rerun_url", "description": "", "isRequired": true }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "integer", "name": "run_number", "description": "", "isRequired": true }, { "type": "string", "name": "run_started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "requested", "in_progress", "completed", "queued", "pending" ] }, { "type": "object or null", "name": "triggering_actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", "name": "workflow_url", "description": "", "isRequired": true } ] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "in_progress", "category": "workflow_run" }, "requested": { "descriptionHtml": "A workflow run was triggered.
", "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", "isRequired": true, "enum": [ "requested" ], "childParamsGroups": [] }, { "type": "object", "name": "enterprise", "in": "body", "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.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "isRequired": true, "childParamsGroups": [] }, { "type": "object or null", "name": "workflow", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "badge_url", "description": "", "isRequired": true }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "state", "description": "", "isRequired": true }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "object", "name": "workflow_run", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object or null", "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "artifacts_url", "description": "", "isRequired": true }, { "type": "string", "name": "cancel_url", "description": "", "isRequired": true }, { "type": "integer", "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", "name": "check_suite_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", "description": "", "isRequired": true, "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null, "skipped", "startup_failure" ] }, { "type": "string", "name": "created_at", "description": "", "isRequired": true }, { "type": "string", "name": "event", "description": "", "isRequired": true }, { "type": "string or null", "name": "head_branch", "description": "", "isRequired": true }, { "type": "object", "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "author", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "object", "name": "committer", "description": "Metaproperties for Git author/committer information.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "date", "description": "" }, { "type": "string or null", "name": "email", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The git author's name.
", "isRequired": true }, { "type": "string", "name": "username", "description": "" } ] }, { "type": "string", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "message", "description": "", "isRequired": true }, { "type": "string", "name": "timestamp", "description": "", "isRequired": true }, { "type": "string", "name": "tree_id", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head_repository", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "head_sha", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "jobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "logs_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string or null", "name": "previous_attempt_url", "description": "", "isRequired": true }, { "type": "array of objects", "name": "pull_requests", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "ref", "description": "", "isRequired": true }, { "type": "object", "name": "repo", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "number", "name": "id", "description": "", "isRequired": true }, { "type": "number", "name": "number", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "array of objects or null", "name": "referenced_workflows", "description": "", "childParamsGroups": [ { "type": "string", "name": "path", "description": "", "isRequired": true }, { "type": "string", "name": "ref", "description": "" }, { "type": "string", "name": "sha", "description": "", "isRequired": true } ] }, { "type": "object", "name": "repository", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "archive_url", "description": "", "isRequired": true }, { "type": "string", "name": "assignees_url", "description": "", "isRequired": true }, { "type": "string", "name": "blobs_url", "description": "", "isRequired": true }, { "type": "string", "name": "branches_url", "description": "", "isRequired": true }, { "type": "string", "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", "name": "commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "compare_url", "description": "", "isRequired": true }, { "type": "string", "name": "contents_url", "description": "", "isRequired": true }, { "type": "string", "name": "contributors_url", "description": "", "isRequired": true }, { "type": "string", "name": "deployments_url", "description": "", "isRequired": true }, { "type": "string or null", "name": "description", "description": "", "isRequired": true }, { "type": "string", "name": "downloads_url", "description": "", "isRequired": true }, { "type": "string", "name": "events_url", "description": "", "isRequired": true }, { "type": "boolean", "name": "fork", "description": "", "isRequired": true }, { "type": "string", "name": "forks_url", "description": "", "isRequired": true }, { "type": "string", "name": "full_name", "description": "", "isRequired": true }, { "type": "string", "name": "git_commits_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", "name": "git_tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", "description": "Unique identifier of the repository
", "isRequired": true }, { "type": "string", "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", "name": "issue_events_url", "description": "", "isRequired": true }, { "type": "string", "name": "issues_url", "description": "", "isRequired": true }, { "type": "string", "name": "keys_url", "description": "", "isRequired": true }, { "type": "string", "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", "name": "languages_url", "description": "", "isRequired": true }, { "type": "string", "name": "merges_url", "description": "", "isRequired": true }, { "type": "string", "name": "milestones_url", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "node_id", "description": "", "isRequired": true }, { "type": "string", "name": "notifications_url", "description": "", "isRequired": true }, { "type": "object or null", "name": "owner", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "boolean", "name": "private", "description": "Whether the repository is private or public.
", "isRequired": true }, { "type": "string", "name": "pulls_url", "description": "", "isRequired": true }, { "type": "string", "name": "releases_url", "description": "", "isRequired": true }, { "type": "string", "name": "stargazers_url", "description": "", "isRequired": true }, { "type": "string", "name": "statuses_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscribers_url", "description": "", "isRequired": true }, { "type": "string", "name": "subscription_url", "description": "", "isRequired": true }, { "type": "string", "name": "tags_url", "description": "", "isRequired": true }, { "type": "string", "name": "teams_url", "description": "", "isRequired": true }, { "type": "string", "name": "trees_url", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true } ] }, { "type": "string", "name": "rerun_url", "description": "", "isRequired": true }, { "type": "integer", "name": "run_attempt", "description": "", "isRequired": true }, { "type": "integer", "name": "run_number", "description": "", "isRequired": true }, { "type": "string", "name": "run_started_at", "description": "", "isRequired": true }, { "type": "string", "name": "status", "description": "", "isRequired": true, "enum": [ "requested", "in_progress", "completed", "queued", "pending", "waiting" ] }, { "type": "object or null", "name": "triggering_actor", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "avatar_url", "description": "" }, { "type": "boolean", "name": "deleted", "description": "" }, { "type": "string or null", "name": "email", "description": "" }, { "type": "string", "name": "events_url", "description": "" }, { "type": "string", "name": "followers_url", "description": "" }, { "type": "string", "name": "following_url", "description": "" }, { "type": "string", "name": "gists_url", "description": "" }, { "type": "string", "name": "gravatar_id", "description": "" }, { "type": "string", "name": "html_url", "description": "" }, { "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "node_id", "description": "" }, { "type": "string", "name": "organizations_url", "description": "" }, { "type": "string", "name": "received_events_url", "description": "" }, { "type": "string", "name": "repos_url", "description": "" }, { "type": "boolean", "name": "site_admin", "description": "" }, { "type": "string", "name": "starred_url", "description": "" }, { "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", "name": "type", "description": "", "enum": [ "Bot", "User", "Organization" ] }, { "type": "string", "name": "url", "description": "" }, { "type": "string", "name": "user_view_type", "description": "" } ] }, { "type": "string", "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", "name": "url", "description": "", "isRequired": true }, { "type": "integer", "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", "name": "workflow_url", "description": "", "isRequired": true }, { "type": "string", "name": "display_title", "description": "", "isRequired": true } ] } ], "availability": [ "business", "repository", "organization", "app" ], "action": "requested", "category": "workflow_run" } } }